Skip to main content
POST
/
cards
/
simulate-refund
Simulate a refund transaction
curl --request POST \
  --url https://access.utgl.io/v1/cards/simulate-refund \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cardAccountId": "c8e2752d-6bd7-4244-a9f6-580f5640eaeb",
  "cardId": "c8e2752d-6bd7-4244-a9f6-580f5640eaec",
  "amount": 100,
  "currency": "HKD"
}
'
{
  "cardTransactionId": "8188d920-2c17-4aba-aa24-6a25f8c12ddb"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
cardAccountId
string
required

The card account ID from the simulate refund

Example:

"c8e2752d-6bd7-4244-a9f6-580f5640eaeb"

​
cardId
string
required

The card ID from the simulate refund

Example:

"c8e2752d-6bd7-4244-a9f6-580f5640eaec"

​
amount
number
required

The amount is refund amount

Example:

100

​
currency
string
required

The currency is amount currency

Example:

"HKD"

Response

200 - application/json

Refund transaction submitted

​
cardTransactionId
string

The ID of the simulated refund transaction

Example:

"8188d920-2c17-4aba-aa24-6a25f8c12ddb"