Skip to content

Get all gift card balances

To get all the gift cards balances created in the platform, you must use:

POST https://[base_url]/v1/gift-cards

Endpoint response

Status code: 200

{
    "paginate_info": {
        "start": 0,
        "items": 10,
        "total_items": 2,
        "total_pages": 1,
        "links": {
            "first": "None?offset=0&limit=10",
            "previous": "None?offset=0&limit=10",
            "next": "None?offset=10&limit=10",
            "last": "None?offset=10&limit=10"
        }
    },
    "data": [
        {
            "code": "81GY29X2B5",
            "total_amount": 1100,
            "available_amount": 0,
            "currency": "COP",
            "gift_card_recipient": {
                "name": "Jane Doe",
                "email": "[email protected]"
            }
        },
        {
            "code": "D32X693Q33",
            "total_amount": 1600,
            "available_amount": 400,
            "currency": "COP",
            "gift_card_recipient": {
                "name": "Jane Doe",
                "email": "[email protected]"
            }
        }
    ]
}

Status code: 401, 403, 404

{
 "code": "Status code",
 "message":"Error description",
 "detail": "Error details"
}