Balance Check Physical

You can use this endpoint to check the balance of a physical gift card.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 5 and 50
^[A-Za-z0-9_-]+$

Unique identifier for this request. Also acts as an idempotency key

string
required
length between 1 and 255
^[a-z0-9-]+$

Brand identifier/slug (lowercase letters, numbers, hyphens only). Must be a brand connected to your buyer account.

face_value
object
required
string
enum
required
length ≥ 1

Must match one of the sectors configured for your buyer account.

string
required
length between 8 and 110
^[a-zA-Z0-9 ._-]+$

Gift card code

string

Gift card PIN. This field is optional and only some brands will require this to be added.

Responses

502

Bad Gateway No response body is returned.

504

Gateway Timeout No response body is returned

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json