Get a payment

Response Description

Example of the response body

{
    "id": "133",
    "gatewayId": "12",
    "status": "PENDING",
    "extra": {
      "accountNumber": "2222222222222222",
      "accountName": "Иванов Иван Иванович",
      "bankName": "bank"
    },
    "paymentCurrency": "RUB",
    "paymentAmount": "4990",
    "destinationCurrency": "USDT",
    "destinationAmount": "string",
    "createdAt": "2023-09-26T13:29:34.172Z"
}

Description of fields:

Field	Type	Description
id	integer	Payment ID
gatewayId	integer	Payment Gateway ID
status	enum	Payment status (list of available status below)
extra	object	Payment details
paymentCurrency	string	Expected currency to be paid
paymentAmount	string	Amount to be paid
destinationCurrency	string	Expected currency of payment crediting in the personal account
destinationAmount	string	Expected deposit amount
createdAt	string	Payment creation date

Please note that the body has the currency/amount to be paid and the currency/amount to be credited. Some gateways can immediately convert the amount received into cryptocurrency

Possible statuses:

Status	Description
PENDING	Payment pending payment or confirmation
REJECTED	Payment rejected. To clarify the details, you need to contact support
CONFIRMED	Payment confirmed by the user
CANCELLED	The payment was rejected by the user or merchant
PROCESSED	Payment successful
ERROR	Error during processing. To clarify the details, you need to contact support

Description of the Extra field

The extra field contains the information necessary for making the payment

For payment methods like p2p, sbp, it will have the following value:

{
      "accountNumber": "2222222222222222",
      "accountName": "Иванов Иван Иванович",
      "bankName": "bank"
}

Description of fields:

aa	aa	aa
accountNumber	string	Details for sending funds
accountName	string	Name of the recipient to check the correctness of entering the details
bankName	string	Name of the recipient's bank for sending correctness

Webhook

When the payment status changes, notifications about the status change will be sent to the specified URL The body of the webhook will be identical to the body of the payment creation/receipt response

{
    "id": "133",
    "gatewayId": "12",
    "status": "PENDING",
    "extra": {
      "accountNumber": "2222222222222222",
      "accountName": "Иванов Иван Иванович",
      "bankName": "bank"
    },
    "paymentCurrency": "RUB",
    "paymentAmount": "4990",
    "destinationCurrency": "USDT",
    "destinationAmount": "string",
    "createdAt": "2023-09-26T13:29:34.172Z"
}

Get a payment

POSThttps://app.apollopayment.io/api-gateway/fiat/get-payment

Header parameters

Body

application/json

idinteger

Payment ID

Example: "133"

Response

200

Body

application/json

success*boolean

Request success indicator

response*FiatPayment (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/api-gateway/fiat/get-payment', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "id": "133",
    "gatewayId": "12",
    "status": "PENDING",
    "extra": {
      "accountNumber": "2222222222222222",
      "accountName": "Иванов Иван Иванович",
      "bankName": "BDSM Bank"
    },
    "paymentCurrency": "RUB",
    "paymentAmount": "4990",
    "destinationCurrency": "USDT",
    "destinationAmount": "14",
    "createdAt": "2024-09-24T12:09:08.788Z"
  }
}