api_gateway_payments_retrieve

GET /api/gateway/payments/:reference/

Retrieve payment intent

Path Parameters

• reference string required

Responses

• 200

---

application/json

Schema

Schema

• id string required
• status object
• token string required
• currency object
• created_at date-time required
• updated_at date-time required
• expires_at date-time required
• pay_address string required
• amount_fiat decimal required

  Possible values: Value must match regular expression ^\d{0,17}(?:\.\d{0,2})?$

• amount_crypto string required
• amount_captured_fiat string required
• amount_captured_crypto string required
• metadata object required
• transactions object[] required

  Array [

  received_amount decimal required

  Possible values: Value must match regular expression ^\d{0,35}(?:\.\d{0,15})?$

  chain_transaction_id string required

  Possible values: <= 255 characters

  created_at date-time required

  ]
• payment_log object required

Example (from schema)

{
  "id": "string",
  "status": "pending",
  "token": "string",
  "currency": "EUR",
  "created_at": "2023-04-20T10:03:58.153Z",
  "updated_at": "2023-04-20T10:03:58.153Z",
  "expires_at": "2023-04-20T10:03:58.153Z",
  "pay_address": "string",
  "amount_fiat": "string",
  "amount_crypto": "string",
  "amount_captured_fiat": "string",
  "amount_captured_crypto": "string",
  "metadata": {},
  "transactions": [
    {
      "received_amount": "string",
      "chain_transaction_id": "string",
      "created_at": "2023-04-20T10:03:58.153Z"
    }
  ],
  "payment_log": {}
}

Authorization

name: jwtAuthtype: httpscheme: bearerbearerFormat: JWT

Request

Bearer Token

reference — path required

curl / cURL

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://docs.kubepay.io/api/gateway/payments/:reference/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'