Top-up Digital Code

Top up a digital gift card using the gift card number and pin.

The serial_number property is required for certain brands using specific processors.

Please note, not all brands support the ability to top up. You can determine which brands are eligible for top-up by checking whether they have the digital_top_up 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 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.

uuid

Unique reference for this transaction

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

Gift card code. Must be between 8 and 110 characters.
Allowed characters: alphanumeric, space, period, underscore, hyphen.

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

Gift card serial number. Required for certain brands.
Must be at least 1 character when provided.

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