Cash Out Original Transaction Physical Card

Cancel an activated physical gift card using the gift card number and (when required by the brand) pin number.
You will be refunded for the remaining balance on the physical gift card.
This endpoint is only available for brands that support the physical_cash_out transaction type.

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.

string
enum
required
length ≥ 1

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

string
required

The long card number on the physical gift card you wish to cash out

string

The pin number (only applies to certain brands which provide pin) on the physical gift card

tags
array

Optional meta data associated with the issuance.

tags
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