Transfergiftcardbalance

curl --request POST \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "securityCode": "<string>",
  "destinationCardNumber": "<string>",
  "amount": 2500.005,
  "description": "<string>",
  "referenceId": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "transferId": "<string>",
  "sourceCard": {
    "id": "5eb7cf5a86d9755df3a6c593",
    "cardNumber": "<string>",
    "remainingBalance": "<string>"
  },
  "destinationCard": {
    "id": "5eb7cf5a86d9755df3a6c593",
    "cardNumber": "<string>",
    "newBalance": "<string>"
  },
  "amountTransferred": "<string>"
}

Gift Cards

Transfergiftcardbalance

Transfer Balance Between Gift Cards

Moves a specified amount from a source gift card to a destination gift card within the same program. The source card’s security code is required to authorise the transfer.

Both cards must be active and belong to the same program. A TRANSFER_OUT transaction is recorded on the source card and a TRANSFER_IN transaction on the destination card.

Business Rules:

Source and destination cards must be different
Both cards must have status active
Source card balance must be >= transfer amount
Destination card balance after transfer must not exceed £10,000.00
Source card security code must match (constant-time comparison)
Transfer depletes source card if resulting balance reaches zero

Status Codes:

200: Transfer completed successfully
400: Invalid amount, insufficient balance, or cards not eligible
401: Incorrect security code
404: Source or destination card not found
409: Card currently locked by another operation

Idempotency Scope:

Idempotency keys are scoped to programId + transfer + sourceCardId + destinationCardId
The same key may be reused for different source/destination pairs or other gift card actions

POST

/

v2

/

giftcards

/

programs

/

{programId}

/

cards

/

{cardId}

/

transfer

Transfergiftcardbalance

curl --request POST \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/cards/{cardId}/transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "securityCode": "<string>",
  "destinationCardNumber": "<string>",
  "amount": 2500.005,
  "description": "<string>",
  "referenceId": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "transferId": "<string>",
  "sourceCard": {
    "id": "5eb7cf5a86d9755df3a6c593",
    "cardNumber": "<string>",
    "remainingBalance": "<string>"
  },
  "destinationCard": {
    "id": "5eb7cf5a86d9755df3a6c593",
    "cardNumber": "<string>",
    "newBalance": "<string>"
  },
  "amountTransferred": "<string>"
}

Authorizations

Authorization

string

header

required

JWT access token obtained from POST /v2/token.

Headers

idempotency-key

string | null

X-Eposn-Customer-Token

string | null

X-Eposn-Merchant-Token

string | null

Path Parameters

programId

string | null

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

cardId

string | null

required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json

securityCode

string

required

Required string length: 6

destinationCardNumber

string

required

Maximum string length: 20

amount

required

Required range: 0.01 <= x <= 5000

description

string | null

Maximum string length: 500

referenceId

string | null

Maximum string length: 100

Response

Successful Response

success

boolean

required

message

string

required

transferId

string

required

sourceCard

TransferBalanceSourceCard · object

required

Show child attributes

destinationCard

TransferBalanceDestCard · object

required

Show child attributes

amountTransferred

string

required

Getgiftcardtransactions Transfergiftcardownership