API reference · Cards & gift cards

Gift cards held elsewhere

POST/gift-card/externalAdd a gift card you already own
DELETE/gift-card/external/{reference}Put a gift card you added away

POST Add a gift card you already own

POST /gift-card/external

Keeps a card another brand issued in your wallet: a place the number stops getting lost, a balance with the date it was true, and a reminder before it lapses. The brand holds the money, so this card cannot be spent through this platform and every response says so. The code itself is optional - leave it out and the card is still tracked.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: RegisterExternalGiftCardRequest · Response: GenericResponseGiftCardResponse

curl -X POST "https://api.bridgemoni.com/gift-card/external" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "brandReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "code": "string",
  "pin": "string",
  "declaredBalance": 4500.0,
  "currencyCode": "NGN",
  "expiryDateTime": "2026-09-25T10:00:00Z",
  "faceValue": 10000.0,
  "reminderMsisdn": "string"
}'

{
  "brandReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "code": "string",
  "pin": "string",
  "declaredBalance": 4500.0,
  "currencyCode": "NGN",
  "expiryDateTime": "2026-09-25T10:00:00Z",
  "faceValue": 10000.0,
  "reminderMsisdn": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "programReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "productReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "brandName": "string",
    "maskedCode": "****VW3XZ",
    "displayPrefix": "string",
    "faceValue": 0,
    "balance": 0,
    "currencyCode": "string",
    "status": "INACTIVE",
    "sourcing": "ISSUED",
    "balanceSource": "BRIDGE_LEDGER",
    "formFactor": "DIGITAL",
    "purchaserUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "holderUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "activatedDateTime": "2026-09-25T10:00:00Z",
    "lastLoadedDateTime": "2026-09-25T10:00:00Z",
    "scheduledForDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "redeemedDateTime": "2026-09-25T10:00:00Z",
    "blockedReason": "string",
    "offlineCap": 0,
    "offlineDrawn": 0,
    "lastCheckedBalance": 0,
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "archivedDateTime": "2026-09-25T10:00:00Z",
    "spendableThroughBridge": true,
    "partialRedemptionPermitted": true,
    "replacedByReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "totalCharged": 0,
    "createdDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Gift card added successfully"
}

Responses

Status	When
`200`	Gift card added successfully

DELETE Put a gift card you added away

DELETE /gift-card/external/{reference}

Takes it out of the wallet without deleting what is known about it. Spent, lost, or no longer wanted.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: ArchiveGiftCardRequest · Response: GenericResponseGiftCardResponse

curl -X DELETE "https://api.bridgemoni.com/gift-card/external/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "string"
}'

{
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "programReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "productReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "brandName": "string",
    "maskedCode": "****VW3XZ",
    "displayPrefix": "string",
    "faceValue": 0,
    "balance": 0,
    "currencyCode": "string",
    "status": "INACTIVE",
    "sourcing": "ISSUED",
    "balanceSource": "BRIDGE_LEDGER",
    "formFactor": "DIGITAL",
    "purchaserUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "holderUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "activatedDateTime": "2026-09-25T10:00:00Z",
    "lastLoadedDateTime": "2026-09-25T10:00:00Z",
    "scheduledForDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "redeemedDateTime": "2026-09-25T10:00:00Z",
    "blockedReason": "string",
    "offlineCap": 0,
    "offlineDrawn": 0,
    "lastCheckedBalance": 0,
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "archivedDateTime": "2026-09-25T10:00:00Z",
    "spendableThroughBridge": true,
    "partialRedemptionPermitted": true,
    "replacedByReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "totalCharged": 0,
    "createdDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Gift card archived successfully"
}

Responses

Status	When
`200`	Gift card archived successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors