v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB

Payments

Get the status of a payment

Returns the status of a payment

get/payments/{paymentId}/status

Path parameters

paymentIdstring required

The unique identifier for the payment.

This can be sourced from the paymentId field in the response we sent to you when creating the payment or payout.

Query parameters

includestring[]

A parameter allowing the inclusion of related information.

This parameter follows closely the JSON:API Inclusion of Related Resources. Specifying valid entries will result in the entities being included in the included section of the response.

Response

paymentIdstring required

Unique identifier for the payment

merchantTransactionIdstring

Your unique identifier that can be used when a connection issue occurs and you don't receive a paymentId. This is an optional field that can be used when querying GET v1/payments, GET v1/payouts or GET v1/payments/{paymentId}/refunds. We will validate the uniqueness of the merchantTransactionId value per retail channel. If a payment/payout/refund is created with merchantTransactionId abc, no other payment/payout/refund can be created with abc.

The merchantTransactionId is a contract between BR-DGE and a merchant. This field will not be mapped downstream to any PSP.

In the event that you provide a merchantTransactionId in the second (or third) leg of a 3DS payment, we will ignore this value and will only use the value provided in the initial request.

codestring required

Response Code signifying the outcome of the request.

messagestring required

A description of the outcome

timestampstring date-time required

Timestamp when the transaction entered its latest status.

relationshipsobject

A map of a specified relation to the identifiable information for that relation. The key of the map is the requested relation information from the include parameter.

Status of the payment. See Transaction Statuses for further detail.

referencestring required

The merchant defined customer order code for the payment.

cashierIdstring

For use by BR-DGE Cashier to link the transaction to a particular Cashier instance.

customMetadataCustomMetadata

Optional custom metadata string fields for the transaction.

Up to 25 fields can be included with the following constraints:

The field name may not be empty or have leading or trailing whitespace, and can consist of upper and lowercase letters, numbers, space, underscore "_", hyphen "-" and single quote "'".

Maximum string length of either field name and field value is 200 chars.

paymentRails'EFTPOS' | 'VISA' | 'MASTERCARD'

Payment rails are the systems and networks that are used to move funds between parties. Card networks can act as payment rails.

This field contains payment rails used for current payment.

EFTPOS - Australia's domestic debit card payments network
VISA - Visa international payment network
MASTERCARD - Mastercard international payment network

amountinteger required

Amount in a currency to be used for the transaction. In the lowest denomination of the currency of the payment. This means that 1234 in GBP represents £12.34.

currencyCodestring required

Currency code of the payment (ISO 4217)

authorizationCodestring

The code provided by the PSP in response to a successfully authorized payment.

Example response

{
  "paymentId": "2c6a34be-f7a1-4b49-b09c-e84e1322df7f",
  "merchantTransactionId": "yourUniqueRequestId",
  "customer": {
    "id": "Customer001"
  },
  "code": "1000",
  "psp": {
    "name": "Checkout.com",
    "transactionId": "6418da68-0b3d-4409-ab14-1ceb752b0b1f",
    "switchAccountId": "switch-account-123",
    "provisionedUserId": "Vx0H4pdAtPCz",
    "additionalInfo": {
      "customerFirstName": "John",
      "customerLastName": "Smith",
      "customerDateOfBirth": "2000-01-01",
      "customerIpAddress": "123.100.100.200",
      "customerId": "de5d7b4a-9410-40e1-85fd-8ceee23c9fd0",
      "paysafecardCustomerId": "151743187547"
    },
    "rawPspResponses": [
      {
        "httpStatusCode": 200,
        "pspName": "Checkout.com",
        "headers": {
          "content-type": [
            "application/json"
          ]
        }
      }
    ]
  },
  "timestamp": "2022-01-30T10:10:10Z",
  "included": [
    {
      "attributes": {
        "metadata": {
          "cardBrand": "MASTERCARD",
          "category": "CLASSIC",
          "countryIsoA2": "GB",
          "commercial": true,
          "bin": "48321456"
        },
        "expiryDate": "05-25",
        "fingerprint": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6"
      }
    }
  ],
  "paymentInstrument": {
    "nameOnCard": "John F Doe",
    "pan": "1234 56## #### 1111",
    "expiryDate": "05-25",
    "cardMetadata": {
      "cardBrand": "MASTERCARD",
      "category": "CLASSIC",
      "countryIsoA2": "GB",
      "commercial": true,
      "bin": "48321456"
    },
    "fingerprint": "63c8563d876b993878e1b5506b5fc5826e9e46266daaadac018a71ed307748c6"
  },
  "status": "CAPTURED",
  "comcardeCode": {
    "code": "1000"
  },
  "riskAssessments": {
    "kount": {
      "score": 85.5,
      "decision": "APPROVED",
      "reasonCode": "APPROVED_3DS_STEP_UP",
      "tags": [
        "3DS_CHALLENGE",
        "NEW_DEVICE"
      ]
    },
    "merchant": {
      "decision": "APPROVED",
      "retryable": true,
      "rawResponse": {
        "httpStatusCode": 200
      }
    }
  },
  "cashierId": "90e7aff7-7e57-459a-a46e-9258c8abc99b",
  "customMetadata": {
    "accountAge": "2",
    "transactionType": "Other"
  },
  "paymentRails": "EFTPOS",
  "keyIdentifiers": {
    "customerIdentifiers": {
      "customerId": "Customer001"
    },
    "paymentInstrumentIdentifiers": {
      "dpan": {
        "id": "dbc8231e-6b85-4955-93ce-938e25ad2f7a"
      }
    }
  },
  "avsResult": {
    "code": "I"
  },
  "amount": 1234,
  "currencyCode": "GBP",
  "scaDetails": {
    "eci": "01"
  },
  "authorizationCode": "123456"
}