v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB

Payment Instrument Tokenization

Get Apple Pay token metadata

Apple Pay tokens contain encrypted data that only BR-DGE can decrypt. This endpoint lets you access that previously encrypted data, along with Bank Identifier Number (BIN) lookup data derived from the decrypted Apple Pay DPAN. This is particularly useful for performing your own pre-payment checks.

post/payment-instruments/apple-pay/query

Request body

tokenstring

If you are directly integrating with Apple Pay APIs on your client app then please refer to our Apple Pay REST API guide for details on how to generate an Apple Pay token for BR-DGE Payments.

Alternatively you can use the BR-DGE Web SDK Apple Pay module to directly generate Apple Pay tokens for BR-DGE Payments.

Example request

{
  "token": "BR#00000000-0000-0000-0000-000000000000"
}

Response

Successful retrieval of Apple Pay details

expiryDatestring

Card expiry date in MM-YY format.

fingerprintstring

A unique token that can be used to detect if two BR-DGE tokens represent the same underlying Payment Instrument.

fingerprintExtendedstring

A fingerprint with card expiry date appended in MMYY format.

Example response

{
  "metadata": {
    "cardBrand": "MASTERCARD",
    "category": "CLASSIC",
    "countryIsoA2": "GB",
    "commercial": true,
    "bin": "48321456"
  },
  "expiryDate": "05-25",
  "fingerprint": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6",
  "decryptedPayload": {
    "applicationPrimaryAccountNumber": "4818528840216497",
    "applicationExpirationDate": "281231",
    "currencyCode": "826",
    "transactionAmount": 100,
    "cardholderName": "John Smith",
    "deviceManufacturerIdentifier": "040010030273",
    "paymentDataType": "3DSecure",
    "paymentData": {
      "eciIndicator": 7
    },
    "transactionId": "31675461ec268fed0ca9699e632753447d1a1de0aa65170e049033d7a801d3f3"
  }
}