B2C

Формирование отчётности по платежам по транзакции/периоду

Песочница
GET https://sandbox.alfabank.ru/api/b2cpay/jp/v1/payments
Пром
GET https://baas.alfabank.ru/api/b2cpay/jp/v1/payments
Scope

b2c_sbp_payments

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

QUERY
Атрибут
Описание
startDate
stringoptional

Дата начала периода

finishDate
stringoptional

Дата окончания периода

transactionId
stringoptional

Идентификатор транзакции в системе банка, по которой необходимо получить детальную информацию

externalId
stringoptional

Идентификатор транзакции в системе клиента, по которой необходимо получить детальную информацию

b2cClientId
stringoptional

Идентификатор клиента, от имени которого отправляется платёж (указывается при использовании API провайдером)

partnerId
integerrequired

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

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/b2cpay/jp/v1/payments?startDate={startDate}&finishDate={finishDate}&transactionId={transactionId}&externalId={externalId}&b2cClientId={b2cClientId}&partnerId={partnerId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "client": {
3    "b2cClientId": "6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4",
4    "partnerId": 214
5  },
6  "payments": [
7    {
8      "account": "40702810401300003178",
9      "inn": "0352417325",
10      "transactionId": "3389",
11      "sequence": "qaqaqa",
12      "payPackage": "5592",
13      "nspkTransactionId": "A3137112354541010000050011000101",
14      "eqTrnId": "C31170523000000X",
15      "nspkBankName": "ПИР Банк",
16      "nspkName": {
17        "first": "Иван",
18        "middle": "Иванович",
19        "last": "Иванов"
20      },
21      "name": {
22        "first": "Иван",
23        "middle": "Иванович",
24        "last": "Иванов"
25      },
26      "nameCheck": true,
27      "orderInfo": {
28        "number": "66",
29        "date": "2023-05-17T14:24:58.078Z",
30        "recipientAccount": "40817495834383110206",
31        "recipientBic": "044525491",
32        "payerAccountType": "BBAN"
33      },
34      "phone": "0079086010338",
35      "amount": 10007.03,
36      "feeAccount": "40702810701300003179",
37      "feeAmount": 1.05,
38      "createDate": "2023-05-17T14:22:40.974Z",
39      "modifyDate": "2023-05-17T14:24:58.078Z",
40      "nspkStatus": "ACWP",
41      "errorDescription": null
42    }
43  ]
44}
BODY
атрибут
описание
objectrequired

Контекст клиента

b2cClientId
stringoptional

Идентификатор клиента, от имени которого отправляется платёж (возвращается при использовании API провайдером)

partnerId
integerrequired

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

array of objectsrequired

Коллекция транзакций на основании параметров запроса. Может содержать транзакции для различных получателей

account
stringrequired

Счёт списания отправителя

inn
stringrequired

ИНН ЮЛ плательщика

transactionId
stringrequired

Уникальный идентификатор транзакции

sequence
stringrequired

Идентификатор платежа внутри пакета. Формируется потребителем сервиса B2C-переводы

payPackage
stringrequired

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

nspkTransactionId
stringoptional

Код транзакции НСПК

eqTrnId
stringoptional
nspkBankName
stringrequired

Наименование банка получателя

objectoptional

ФИО получателя в НСПК

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

objectoptional

ФИО получателя из запроса платежа

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

nameCheck
booleanoptional

Переданный в запросе флаг необходимости проверки совпадения переданного ФИО получателя и зарегистрированного ФИО получателя в НСПК

objectoptional

Информация о платёжном поручении

number
stringoptional

Номер платёжного поручения

date
stringoptional

Дата платёжного поручения

recipientAccount
stringoptional

Расчётный счёт ФЛ в банке-получателе

recipientBic
stringoptional

БИК банка-получателя

payerAccountType
stringrequired

Тип идентификатора счёта плательщика

phone
stringrequired

Телефон получателя

amount
numberrequired

Сумма платежа

feeAccount
stringoptional

Счёт списания комиссии платежа. Может отличаться от основного счёта списания ДС

feeAmount
numberrequired

Сумма комиссии платежа

createDate
stringrequired

Дата/Время создания платежа (в формате 2023-03-28T19:47:21.644Z)

modifyDate
stringrequired

Дата/Время изменения платежа (в формате 2023-03-28T19:47:21.644Z)

nspkStatus
stringrequired

Статус платежа в НСПК. Возможные значения:

  • •
    RCVD - принят, находится в обработке;
  • •
    RJCT - отклонён;
  • •
    ACWP - исполнен
errorDescription
stringoptional

Описание ошибки платежа. Возвращается в случае ошибки платежа в НСПК (поле nspkStatus имеет значение RJCT)

Пример ответа 200 (OK)
1{
2  "client": {
3    "b2cClientId": "6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4",
4    "partnerId": 214
5  },
6  "payments": [
7    {
8      "account": "40702810401300003178",
9      "inn": "0352417325",
10      "transactionId": "3389",
11      "sequence": "qaqaqa",
12      "payPackage": "5592",
13      "nspkTransactionId": "A3137112354541010000050011000101",
14      "eqTrnId": "C31170523000000X",
15      "nspkBankName": "ПИР Банк",
16      "nspkName": {
17        "first": "Иван",
18        "middle": "Иванович",
19        "last": "Иванов"
20      },
21      "name": {
22        "first": "Иван",
23        "middle": "Иванович",
24        "last": "Иванов"
25      },
26      "nameCheck": true,
27      "orderInfo": {
28        "number": "66",
29        "date": "2023-05-17T14:24:58.078Z",
30        "recipientAccount": "40817495834383110206",
31        "recipientBic": "044525491",
32        "payerAccountType": "BBAN"
33      },
34      "phone": "0079086010338",
35      "amount": 10007.03,
36      "feeAccount": "40702810701300003179",
37      "feeAmount": 1.05,
38      "createDate": "2023-05-17T14:22:40.974Z",
39      "modifyDate": "2023-05-17T14:24:58.078Z",
40      "nspkStatus": "ACWP",
41      "errorDescription": null
42    }
43  ]
44}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}