Cancel Digital Gift Card

delete

https://sandbox.tillo.dev/api/v2/digital/issue

Cancel an issued digital gift card.

You must provide either a Code or URL from the original issue response. You cannot provide both.

If you are cancelling a Reward Pass product, you only need to provide the original client request ID from the original issue response. You don't need a code or URL in this case.

Please note, not all brands support the ability to cancel. You can determine which brands are eligible for cancellation by checking whether it has the cancelled_digital_issuance transaction type from the GET /api/v2/brands endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

client_request_id

string

required

length between 5 and 50

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

original_client_request_id

string

required

length between 5 and 50

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

brand

string

required

length between 1 and 255

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

face_value

object

required

sector

string

enum

required

length ≥ 1

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

code

string

length between 8 and 110

Gift card code to cancel (for code-delivery brands).
Must be between 8 and 110 characters. Only alphanumeric characters, dots, underscores, hyphens, colons, and forward slashes are allowed.

string

Gift card PIN. Required for cancelling certain brands when the original issue response included a PIN.

url

uri

length between 8 and 255

Gift card URL to cancel (for URL-delivery brands).
Must be between 8 and 255 characters and be a valid URI.

200Successful Response

400Bad Request

401Authentication failed. Invalid API key, signature, or timestamp.

422Unprocessable Entity

429Too many requests. Rate limit exceeded.

500Internal Server Error