Get refund(s) from a payment

Returns refund(s) against a 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.

Example:yourUniqueRequestId

The unique identifier that is set in POST /v1/payments/{paymentId}/refund.

Response

OK

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.

status'APPROVED' | 'PENDING' | 'DECLINED' | 'UNKNOWN' required

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

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.

customerRefundCodestring

You may provide your own code to be used in refunds, which will be provided to the PSP if it is supported. Each PSP may have different validation requirements for this code.

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",
    "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": "APPROVED",
    "amount": 1234,
    "customerRefundCode": "ABC123"
  }
]

v1

Get refund(s) from a payment

Query parameters

Response

Example response