Reverse Digital Code

Reverse an issued digital gift card.

This endpoint allows you to reverse an issued digital gift card using just the original_client_request_id. This can be a useful alternative to cancellation when the original issuance timed out and you may not have access to the code or URL from the issuance response. However, please note that this endpoint can only be used within 48 hours of the original issuance.

Please note, not all brands support the ability to reverse. You can determine which brands are eligible for reversal by checking whether they have the cancelled_digital_issuance transaction type from the GET /api/v2/brands endpoint.

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
enum
required
length ≥ 1

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

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