Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Cards

Reloadgiftcard

Reload Gift Card

Adds funds to an active gift card. Creates a RELOAD transaction for audit trail.

Business Rules:

  • Only ACTIVE cards can be reloaded
  • Card must not be expired
  • Reload amount: $0.01 - $5,000 per transaction
  • Maximum card balance: $10,000
  • New balance = current balance + reload amount
  • Transaction includes before/after balance tracking

Path Parameters:

  • programId: MongoDB ObjectId of the loyalty program
  • cardId: MongoDB ObjectId of the gift card

Request Body:

  • amount: Amount to add ($0.01 - $5,000)
  • referenceId: External reference ID for tracking (optional)
  • description: Transaction description (optional, defaults to "Gift card reload")

Returns:

  • Updated gift card details with new balance
  • Balance reflects immediately after reload

Status Codes:

  • 200: Gift card reloaded successfully
  • 400: Cannot reload (inactive, expired, or would exceed max balance of $10,000)
  • 404: Gift card not found or doesn't belong to program
  • 401: Unauthorized

Error Response (Max Balance Exceeded):

{
    "detail": "Reload would exceed maximum card balance",
    "currentBalance": 9500.00,
    "reloadAmount": 1000.00,
    "maxBalance": 10000.00,
    "availableReloadAmount": 500.00
}

Idempotency Scope:

  • Idempotency keys are scoped to programId + reload + cardId
  • The same key may be reused for different cards or different gift card actions
post/v2/giftcards/programs/{programId}/cards/{cardId}/reload

Path parameters

programIdstring required
Example:5eb7cf5a86d9755df3a6c593
cardIdstring required
Example:5eb7cf5a86d9755df3a6c593

Headers

idempotency-keystring nullable
X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Request body

referenceIdstring nullable
descriptionstring nullable

Response

Successful Response

idstring required
cardNumberstring required
balancestring required
initialValuestring required
status'pending' | 'active' | 'suspended' | 'expired' | 'voided' | 'depleted' required

Gift card status enumeration.

createdAtstring date-time required
updatedAtstring date-time nullable required
activatedAtstring date-time nullable required
expiresAtstring date-time required
suspendedReasonstring nullable required
suspendedUntilstring date-time nullable required
suspendedAtstring date-time nullable required
customerIdstring required
customerEmailstring nullable required
customerPhonestring nullable required
customerNamestring nullable required
senderNamestring nullable
merchantIdstring required
merchantNamestring nullable
isPhysicalboolean required
designTemplatestring nullable required
customMessagestring nullable required
lastFourDigitsstring required
programIdstring required
deliverAtstring date-time nullable
deliveredboolean

Example response

{
  "id": "5eb7cf5a86d9755df3a6c593",
  "customerId": "5eb7cf5a86d9755df3a6c593",
  "merchantId": "5eb7cf5a86d9755df3a6c593",
  "programId": "5eb7cf5a86d9755df3a6c593"
}