Cancel Top-up on a Physical Card

Cancel a top-up on a physical gift card using the gift card number. Some brands will additionally require a PIN number.

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 5 and 50
^[A-Za-z0-9_-]+$

This field will be the client_request_id provided in the original transaction. For example, if you are performing some form of cancellation, then this would be the client_request_id you provided when making the original issuance request

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
required
length between 8 and 110
^[a-zA-Z0-9:_\-:\/]+$
string
length between 3 and 20
^[a-zA-Z0-9_-]+$

Gift card PIN. Required for certain brands.
Must be between 3 and 20 characters when provided.
Allowed characters: alphanumeric, underscore, hyphen.

string
enum
required
length ≥ 1

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

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