API reference · Cards & gift cards

Gift card brands and sourcing

GET/gift-card/brandList gift card brands
GET/gift-card/brand/{reference}Fetch one gift card brand
GET/gift-card/sourced/{reference}Fetch a sourced gift card order
GET/gift-card/{reference}/balance-checkThe balance figures held for a gift card

GET List gift card brands

GET /gift-card/brand

Pass sourceable=true for the brands whose cards can be bought here today.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Query parameters

Name	Default
`sourceable`
`page`	0
`size`	20

Example

Response: GenericResponseListGiftCardBrandResponse

curl -X GET "https://api.bridgemoni.com/gift-card/brand?sourceable=value&page=value&size=20" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "string",
      "code": "string",
      "countryCode": "string",
      "logoDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "websiteUrl": "string",
      "termsUrl": "string",
      "redeemInstruction": "string",
      "categoryCode": "string",
      "status": "DRAFT",
      "sourcingSupported": true,
      "registrationSupported": true,
      "balanceCheckMode": "PROVIDER_API",
      "codeFormatPattern": "string",
      "pinRequired": true,
      "defaultValidityMonths": 0,
      "withdrawnDateTime": "2026-09-25T10:00:00Z",
      "withdrawnReason": "string"
    }
  ],
  "description": "Gift card brands retrieved successfully"
}

Responses

Status	When
`200`	Gift card brands retrieved successfully

GET Fetch one gift card brand

GET /gift-card/brand/{reference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseGiftCardBrandResponse

curl -X GET "https://api.bridgemoni.com/gift-card/brand/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "string",
    "code": "string",
    "countryCode": "string",
    "logoDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "websiteUrl": "string",
    "termsUrl": "string",
    "redeemInstruction": "string",
    "categoryCode": "string",
    "status": "DRAFT",
    "sourcingSupported": true,
    "registrationSupported": true,
    "balanceCheckMode": "PROVIDER_API",
    "codeFormatPattern": "string",
    "pinRequired": true,
    "defaultValidityMonths": 0,
    "withdrawnDateTime": "2026-09-25T10:00:00Z",
    "withdrawnReason": "string"
  },
  "description": "Gift card brand retrieved successfully"
}

Responses

Status	When
`200`	Gift card brand retrieved successfully

GET Fetch a sourced gift card order

GET /gift-card/sourced/{reference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseSourcedGiftCardOrderResponse

curl -X GET "https://api.bridgemoni.com/gift-card/sourced/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "cardReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "brandName": "string",
    "orderState": "PENDING",
    "providerOrderReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "faceValue": 0,
    "currencyCode": "string",
    "maskedCode": "string",
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "amountCharged": 0,
    "failureReason": "string",
    "placedDateTime": "2026-09-25T10:00:00Z",
    "spendableThroughBridge": true
  },
  "description": "Gift card order retrieved successfully"
}

Responses

Status	When
`200`	Gift card order retrieved successfully

GET The balance figures held for a gift card

GET /gift-card/{reference}/balance-check

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListGiftCardBalanceCheckResponse

curl -X GET "https://api.bridgemoni.com/gift-card/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/balance-check" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "cardReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "brandReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "balanceSource": "BRIDGE_LEDGER",
      "outcome": "string",
      "balance": 0,
      "currencyCode": "string",
      "checkedDateTime": "2026-09-25T10:00:00Z",
      "providerReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "failureReason": "string"
    }
  ],
  "description": "Gift card balance history retrieved successfully"
}

Responses

Status	When
`200`	Gift card balance history retrieved successfully

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