Получение платежа

Описание ответа

Пример тела ответа

{
    "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"
}

Описание полей:

Поле	Тип	Описание
id	integer	Идентификатор платежа
gatewayId	integer	Идентификатор платежного шлюза
status	enum	Статус платежа (список доступных статус ниже)
extra	object	Данные для проведения оплаты
paymentCurrency	string	Ожидаемая валюта к оплате
paymentAmount	string	Сумма к оплате
destinationCurrency	string	Ожидаемая валюта зачисления платежа в личном кабинете
destinationAmount	string	Ожидаемая сумма зачисления
createdAt	string	Дата создания платежа

Обратите внимание что теле есть валюта/суммы для оплаты и валюта/сумма к зачислению. Некоторые шлюзы могут сразу конвертировать полученную сумму в криптовалюту

Возможные статусы:

Статус	Описание
PENDING	Платеж в ожидании оплаты или подтверждения
REJECTED	Платеж отклонен. Для уточнения деталей необходимо связаться с поддержкой
CONFIRMED	Оплата подтверждена пользователем
CANCELED	Платеж отклонен пользователем или мерчантом
PROCESSED	Платеж успешен
ERROR	Ошибка в процессе обработки. Для уточнения деталей необходимо связаться с поддержкой

Описание поля Extra

В поле extra находится информация необходимая для проведения оплаты

Для платежных методов типа p2p, sbp оно будет иметь следующее значение:

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

Описание полей:

aa	aa	aa
accountNumber	string	Реквизиты для отправки средств
accountName	string	Имя получателя для проверки корректности ввода реквизитов
bankName	string	Наименование банка получателя для корректности отправки

Webhook

При изменении статуса платежа на указанный URL будут приходить уведомления об изменении статуса Тело вебхука будет идентично телу ответа создания/получения платежа

{
    "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"
}

Получение платежа

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

Header parameters

Body

application/json

idinteger

Идентификатор платежа

Example: "133"

Response

200

Body

application/json

success*boolean

Признак успешности запроса

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-08-15T15:20:13.728Z"
  }
}