Create a gift card transaction

Creates a new gift card transaction. The two most important fields for creating a new gift card transaction are the number of the gift card and the type of the transaction. The type determines what sort of transaction it is.

  • "REDEEMING" - Use this type when you want to redeem a certain amount from the gift card balance. The amount MUST be negative. If you want to add an amount to the balance use the "RELOADING" type.
  • "RELOADING" - Use this type when you load a new amount onto a gift card.

If the gift card does not have enough credit to honour the transaction a 422 HTTP status code will be returned.

Idempotency

Please populate the client_id field with a unique transaction identifier, to ensure that the transaction is safe from double-submit problems. See the tutorial for more information.

🔒 Requires: gift_cards:write:redeem scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The number of the gift card to add the transaction to.

Body Params

Create gift card transaction parameters

The parameters that can be passed to the create giftcard API.

double
required

The amount to be loaded onto the gift card.

string
required

The client id is a unique transaction identifier. The client must provide this and is normally the transaction id from the client system.

string

The expiry date time of the gift card.

string

The timezone of the date times for the gift card.

string
enum
required

The type of the transaction

Allowed:
uuid

The ID of the user creating the gift card.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json