Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB
Payouts

Query Payouts

Search for payouts

get/payouts

Query parameters

merchantTransactionIdstring required

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.

Example:yourUniqueRequestId

The unique identifier that was set in POST /v1/payouts.

Response

OK

paymentIdstring required

Unique identifier for the payment

merchantTransactionIdstring required

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.

status'PENDING' | 'APPROVED' | 'DECLINED' | 'REJECTED' | 'HELD' | 'CANCELLED' | 'BLOCKED' | 'UNKNOWN' required

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

referencestring

Merchant provided reference for this payout

cashierIdstring

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

amountinteger required

The amount provided in the initial request. This will be in the lowest denomination of the currency. This means that 1234 in GBP represents £12.34.

currencyCodestring required

Currency code of the payment (ISO 4217)

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",
    "status": "APPROVED",
    "paymentInstrument": {
      "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"
      },
      "cardMetadata": {
        "cardBrand": "MASTERCARD",
        "category": "CLASSIC",
        "countryIsoA2": "GB",
        "commercial": true,
        "bin": "48321456"
      }
    },
    "reference": "payment-abc",
    "cashierId": "90e7aff7-7e57-459a-a46e-9258c8abc99b",
    "amount": 1234,
    "currencyCode": "GBP",
    "recipient": {
      "email": "john.smith@example.com",
      "phoneNumber": "+44 123 1110000"
    }
  }
]