Get a payment

GET /api/payments/payments/{paymentId}

Try it

Get a payment

cURL

curl --request GET \
  --url http://localhost/api/payments/payments/{paymentId} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "XXX",
    "reference": "<string>",
    "sourceAccountID": "<string>",
    "destinationAccountID": "<string>",
    "connectorID": "<string>",
    "type": "PAY-IN",
    "status": "PENDING",
    "initialAmount": 100,
    "amount": 100,
    "scheme": "unknown",
    "asset": "USD",
    "createdAt": "2023-11-07T05:31:56Z",
    "raw": {},
    "adjustments": [
      {
        "reference": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "status": "PENDING",
        "amount": 100,
        "raw": {}
      }
    ],
    "metadata": {},
    "provider": "STRIPE"
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

paymentId · string · required

The payment ID.

Response

200

application/json

OK

data · object · required

Show child attributes

data. id · string · required

Example:

"XXX"

data. reference · string · required

data. sourceAccountID · string · required

data. destinationAccountID · string · required

data. connectorID · string · required

data. type · enum<string> · required

Available options: PAY-IN, PAYOUT, TRANSFER, OTHER

data. status · enum<string> · required

Available options: PENDING, SUCCEEDED, CANCELLED, FAILED, EXPIRED, REFUNDED, REFUNDED_FAILURE, DISPUTE, DISPUTE_WON, DISPUTE_LOST, OTHER

data. initialAmount · integer<bigint> · required

Required range: x >= 0

Example:

100

data. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data. scheme · enum<string> · required

Available options: unknown, other, visa, mastercard, amex, diners, discover, jcb, unionpay, alipay, cup, sepa debit, sepa credit, sepa, apple pay, google pay, doku, dragonpay, maestro, molpay, a2a, ach debit, ach, rtp

data. asset · string · required

Example:

"USD"

data. createdAt · string<date-time> · required

data. raw · object · required

data. adjustments · object[] · required

Show child attributes

data.adjustments. reference · string · required

data.adjustments. createdAt · string<date-time> · required

data.adjustments. status · enum<string> · required

Available options: PENDING, SUCCEEDED, CANCELLED, FAILED, EXPIRED, REFUNDED, REFUNDED_FAILURE, DISPUTE, DISPUTE_WON, DISPUTE_LOST, OTHER

data.adjustments. amount · integer<bigint> · required

Required range: x >= 0

Example:

100

data.adjustments. raw · object · required

data. metadata · object · required

Show child attributes

data.metadata. {key} · string

data. provider · enum<string>

Available options: STRIPE, DUMMY-PAY, WISE, MODULR, CURRENCY-CLOUD, BANKING-CIRCLE, MANGOPAY, MONEYCORP, ATLAR, ADYEN, GENERIC