Get payment

Get a payment by it’s paymentId.

GET /v2/payments/{paymentId}

Get payment

cURL

curl --request GET \
  --url https://{host}/payment/v2/payments/{paymentId} \
  --header 'Authorization: <api-key>'

200

{
  "paymentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "Payment",
  "receiptId": "<string>",
  "storeId": "<string>",
  "state": "WaitingMemberConfirmation",
  "amount": 123,
  "paymentMethods": [
    {
      "type": "Bonus",
      "state": "WaitingReservation",
      "amount": 123,
      "card": {
        "pan": "<string>",
        "type": "<string>",
        "fundsType": "Unknown"
      },
      "failureCause": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

paymentId · string · required

Response

200

application/json

OK

paymentId · string · required

The payment identifier

Minimum string length: 1

createdAt · string<date-time> · required

Timestamp when the transaction was created

type · enum<string> · required

Available options: Payment, Refund

receiptId · string · required

The receipt identifier

Minimum string length: 1

storeId · string · required

The store identifier

Minimum string length: 1

state · enum<string> · required

Available options: WaitingMemberConfirmation, WaitingPosCapture, Captured, Canceled, WaitingRefund, Refunded, WaitingExternalAction

amount · number<double> · required

The amount that the transaction was created with

paymentMethods · object[] · required

The collection of payment methods selected by the member

Show child attributes