Перейти к основному содержимому

Выдача и возврат перевода

На данной странице вы найдете методы и вебхуки, которые понадобятся платежному партнеру для выдачи денежных средств получателю при успешном переводе или возврата денег отправителю.

Обратите внимание, что перевод можно выдать или вернуть только полностью.

Общий порядок запросов следующий:

  1. В случае выдачи перевода за границей, Банк пришлет нотификацию об успешной выдаче, которую платежный партнер должен уметь корректно обработать. Чтобы не получать данное уведомление, платежный партнер может связаться с менеджером Банка 131.
  2. Получатель обращается к платежному партнеру с паспортом и кодом перевода, полученным при его отправлении.
  3. Платежный партнер инициирует платежную сессию на выдачу перевода и передает в Банк подробную информацию о Получателе.
  4. Банк создает транзакцию и возвращает результат создания.
  5. После получения ответа необходимо дождаться вебхука ready_to_confirm, в котором будет подробная информация о сумме к выплате и данные о получателе.
  6. После получения вебхука ready_to_confirm необходимо будет подтвердить транзакцию методом session/confirm или отклонить ее методом session/cancel.
  7. Для завершения транзакции дождитесь вебхука payment_finished.

Общая схема выдачи наличных​

Общая схема выдачи наличных

Вебхук transaction_registration​

В случае успешной выдачи денег за границей Банк пришлет платежному партнеру вебхук transaction_registration, на который платежный партнер должен будет дать ответ.
В вебхуке будет передана следующая основная информация:

  • родительская сессия, в рамках которой средства были приняты (session_payment_id),
  • текущая сессия, в рамках которой деньги были выданы (session_id),
  • сумма выдачи.

Платежный партнер может отключить передачу данного вебхука. Для этого надо обратиться к менеджеру Банка 131.

Параметры вебхука​

НазваниеОбязательностьТип данныхОписание
session_payment_id+stringID сессии payment
session+objectДанные сессии
  id+stringID сессии payout
  status+stringТекущий статус сессии. Возможные значения
  created_at+stringДата и время создания сессии в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
  updated_at+stringДата и время обновления сессии в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
  error-objectОшибка. Возвращается только если была ошибка по сессии
    description-stringОписание ошибки
    code-stringКод ошибки
  payments+arrayДанные платежа
    id+stringID платежа
    status+stringТекущий статус платежа. Возможные значения
    created_at+stringДата и время создания платежа в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
    finished_at-stringДата и время финализации платежа в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
    payment_method+objectСпособ платежа
      type+stringНазвание способа платежа. Возможное значение: moneysend
    amount_details+objectОбъект amount_details, переданный в запросе
      amount+intСумма в минорных значениях
      currency+stringВалюта
    paymentMetadata-objectДополнительные метаданные
      parentSessionId-stringНомер сессии payment
    participant_details+objectИнформация об отправителе и получателе. Объект гарантирован. Все ключи и вложенные объекты не гарантируются
      sender-objectДанные отправителя. Объект гарантирован. Все ключи и вложенные объекты не гарантируются
      recipient-objectДанные получателя. Объект гарантирован. Все ключи и вложенные объекты не гарантируются
    error-objectПричина ошибки транзакции. Возвращается только если была ошибка по сессии
      description-stringОписание ошибки
      code-stringКод ошибки
Пример вебхука 
{
  "session_payment_id": "ps_949108",
  "session": {
    "id": "ps_949139",
    "status": "accepted",
    "created_at": "2023-03-03T15:00:05.864870Z",
    "updated_at": "2023-03-03T15:00:06.307414Z",
    "payments": [
      {
        "id": "po_231420",
        "status": "succeeded",
        "created_at": "2023-03-03T15:00:05.948271Z",
        "finished_at": "2023-03-03T15:00:06.136321Z",
        "payment_method": {
          "type": "moneysend",
          "moneysend": {}
        },
        "amount_details": {
          "amount": 143000,
          "currency": "USD"
        },
        "paymentMetadata": {
          "parentSessionId": "ps_949108"
        },
        "participant_details": {
          "sender": {
            "full_name": "Анастасия Медынич Олеговна",
            "first_name": "Анастасия",
            "last_name": "Медынич",
            "middle_name": "Олеговна",
            "country_iso3": "RUS",
            "city": "Стерлитамак",
            "postal_code": "",
            "building": "1",
            "date_of_birth": "1994-01-06",
            "street": "Конаковская",
            "state": "Республика Башкортостан",
            "description": "описание описания",
            "identity_document": {
              "id_type": "Паспорт гражданина Российской Федерации",
              "id_number": "6916 706690",
              "issue_date": "2020-01-01",
              "division_code": "",
              "issued_by": "ОВД ПО Кировскому району"
            },
            "citizenship_country_iso3": "RUS",
            "service_point": {
              "id": "1",
              "name": "точка на Ленина",
              "country_iso3": "RUS",
              "state": "Москва",
              "city": "Москва",
              "street": "Ленина",
              "house": "1",
              "oktmo": "36634436111",
              "terminal_id": "345"
            },
            "source_of_money": "зарплата",
            "contacts": {
              "phone": {
                "full_number": "+79376151530",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "6151530"
              }
            }
          },
          "recipient": {
            "full_name": "Ivan Olegov Sergeevich",
            "first_name": "Ivan",
            "last_name": "Olegov",
            "middle_name": "Sergeevich",
            "date_of_birth": "1987-11-08",
            "currency": "USD",
            "contacts": {
              "phone": {
                "full_number": "+43523452345",
                "country_iso3": "TUR",
                "operator_code": "352",
                "short_number": "3452345"
              }
            }
          }
        }
      }
    ]
  }
}

Параметры ответа​

НазваниеОбязательностьТип данныхОписание
status+stringСтатус регистрации. Возможные значения:
succeeded — успешно зарегистрирован
failed — ошибка регистрации
already — запись уже существует
status_details+stringДетальная информация о статусе регистрации
Пример ответа 
{
  "status": "failed",
  "status_details": "No such session_payment_id: ps_948536"
}

Метод POST…/api/v1/cash/payout/session/init​

Метод предназначен для старта выдачи перевода получателю или возврата денег отправителю. Набор параметров в обоих случаях одинаков. Чтобы вернуть перевод отправителю, данные отправителя (participant_details.sender) и получателя перевода (participant_details.recipient) в запросе должны совпадать.

Обратите внимание, что в параметр tcn_code_encoded передается код перевода, который необходимо обернуть в BASE64.

Параметры запроса​

НазваниеОбязательностьТип данныхОписание
tcn_code_encoded+stringКонтрольный номер перевода, полученный от Получателя и обернутый в BASE64. Пример: MzU4MDctMjM1ODk=
payment_method+objectИнформация о методе платежа
  type+stringСпособ платежа. Возможное значение: moneysend
  moneysend+objectДетали платежа через Moneysend
amount_details+objectСумма и валюта к выдаче
  amount+intСумма к выдаче
  currency+stringВалюта к выдаче
participant_details+objectИнформация об отправителе, получателе и точке выдачи
  recipient+objectИнформация о получателе
    citizenship_country_iso3+stringСтрана гражданства получателя по стандарту ISO3166-1 alpha-3
    first_name+stringИмя получателя
    last_name+stringФамилия получателя
    middle_name-stringОтчество получателя
    country_iso3+stringСтрана регистрации получателя по стандарту ISO3166-1 alpha-3
    state-stringРегион или район регистрации получателя
    city+stringНаселенный пункт регистрации получателя
    postal_code-stringПочтовый индекс места регистрации получателя
    street-stringНазвание улицы места регистрации получателя
    building+stringНомер дома места регистрации получателя
    flat-stringКвартира места регистрации получателя
    tax_reference-string12-значный ИНН получателя
    date_of_birth+stringДата рождения получателя. Убедитесь, что возраст получателя 18+
    contacts+objectКонтакты получателя
      phone-objectТелефон получателя
        full_number+stringПолный номер телефона получателя в формате +<код страны><номер>
        country_iso3+stringКод страны, к которой относится номер телефона получателя, в формате ISO3
        operator_code+stringКод оператора телефонного номера получателя
        short_number+stringНомер телефона получателя без кода оператора
      email-stringEmail получателя
    identity_document+objectДанные документа, удостоверяющего личность получателя
      id_type+stringТип документа, удостоверяющего личность получателя. Возможные значения:
— Паспорт иностранного гражданина
— Паспорт гражданина Российской Федерации
      id_number+stringСерия и номер документа, удостоверяющего личность получателя (без пробелов)
      issue_date+stringДата выдачи документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД
      id_expiration_date-stringДата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД. Обязательно для заполнения при наличии в документе. Если его нет, просто не передавайте это поле
      division_code-stringКод подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно для заполнения при наличии в документе
      issued_by-stringНазвание подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно для заполнения при наличии в документе
    documents_foreigner-objectПараметры документа получателя-нерезидента. Обязательно для заполнения, если получатель является иностранным гражданином и выплата происходит в РФ
      id_type+stringТип документа, удостоверяющего личность отправителя-нерезидента. Возможные значения:
— Вид на жительство
— Разрешение на временное проживание
— Миграционная карта
— Виза
      issued_by-stringНазвание органа, выдавшего документ, удостоверяющий личность получателя
      issue_date+stringДата начала срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД
      id_expiration_date+stringДата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД
    service_point+objectТочка выдачи денежных средств
      id-stringID точки выдачи
      name-stringНазвание точки выдачи
      country_iso3+stringСтрана точки выдачи. Формат ISO 3166-1 alpha-3
      state-stringРегион/район нахождения точки выдачи
      city+stringНаселенный пункт нахождения точки выдачи
      oktmo-stringКод ОКТМО расположения точки выдачи средств
      street-stringУлица нахождения точки выдачи
      house-stringЗдание нахождения точки выдачи
      terminal_id-stringНомер терминала/кассы
    source_of_money-stringИсточник происхождения денег
    description-stringДополнительная информация о переводе
  sender+objectИнформация об отправителе
    citizenship_country_iso3+stringСтрана гражданства отправителя по стандарту ISO3166-1 alpha-3
    first_name+stringИмя отправителя
    last_name+stringФамилия отправителя
    middle_name-stringОтчество отправителя
    contacts+objectКонтакты отправителя
      phone-objectТелефон отправителя
        full_number+stringПолный номер телефона отправителя в формате +<код страны><номер>
        country_iso3+stringКод страны, к которой относится номер телефона отправителя, в формате ISO3
        operator_code+stringКод оператора телефонного номера отправителя
        short_number+stringНомер телефона отправителя без кода оператора
      email-stringEmail отправителя
cash_details+objectДополнительная информация о платеже наличными
  shift+stringНомер кассовой смены
Пример запроса 
{
  "tcn_code_encoded": "NTkyMjM3LTg5MjEzNDk5",
  "payment_method": {
    "type": "moneysend",
    "moneysend": {}
  },
  "cash_details": {
    "shift": "159"
  },
  "amount_details": {
    "amount": 1000,
    "currency": "rub"
  },
  "participant_details": {
    "recipient": {
      "citizenship_country_iso3": "AUS",
      "first_name": "Ivan",
      "last_name": "Sidorov",
      "middle_name": "Ivanovich",
      "country_iso3": "RUS",
      "state": "New York",
      "city": "Kazan",
      "postal_code": "420000",
      "street": "Nerkasova",
      "building": "1",
      "flat": "131",
      "tax_reference": "123456789012",
      "date_of_birth": "2008-01-01",
      "identity_document": {
        "id_type": "Паспорт гражданина Российской Федерации",
        "id_number": "123456789",
        "issue_date": "2020-01-01",
        "id_expiration_date": "2030-01-01",
        "division_code": "165-065",
        "issued_by": "OVD Kazani"
      },
      "documents_foreigner": {
        "id_type": "Виза",
        "issued_by": "OVD Kazani",
        "issue_date": "2020-01-01",
        "id_expiration_date": "2030-01-01"
      },
      "service_point": {
        "id": "1",
        "name": "point_on_lenina",
        "country_iso3": "RUS",
        "state": "Moscow",
        "city": "Moscow",
        "oktmo": "36634436111",
        "street": "Lenin avenue",
        "house": "1",
        "terminal_id": "123124"
      },
      "source_of_money": "salary",
      "description": "salary transfers",
      "contacts": {
        "phone": {
          "full_number": "+79377654321",
          "country_iso3": "RUS",
          "operator_code": "937",
          "short_number": "7654321"
        },
        "email": "test@test.com"
      }
    },
    "sender": {
      "first_name": "Ivan",
      "last_name": "Ivanov",
      "middle_name": "Ivanovich",
      "contacts": {
        "phone": {
          "full_number": "+79371234567",
          "country_iso3": "RUS",
          "operator_code": "937",
          "short_number": "1234567"
        },
        "email": "test@test.com"
      }
    }
  }
}

Параметры ответа​

НазваниеОбязательностьТип данныхОписание
status+stringСтатус запроса
session+objectДанные сессии
  id+stringID сессии. Запомните его, он будет нужен для подтверждения/отклонения транзакции или для получения статуса по транзакции
  status+stringТекущий статус сессии. Возможные значения
  created_at+stringДата и время создания сессии в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
  updated_at+stringДата и время обновления сессии в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
  error-objectПричина ошибки. Возвращается только если была ошибка по сессии
    description-stringОписание ошибки
    code-stringКод ошибки
  payments+arrayДанные платежа
    id+stringID платежа
    status+stringТекущий статус платежа. Возможные значения
    created_at+stringДата и время создания платежа в формате RFC 3339. Пример: 2022-11-15T15:38:50.255803Z
  payment_method+objectИнформация о методе платежа
    type+stringСпособ платежа. Возможное значение: moneysend
    participant_details+objectОбъект participant_details, переданный в запросе
  recipient+objectИнформация о получателе
    citizenship_country_iso3+stringСтрана гражданства получателя по стандарту ISO3166-1 alpha-3
    first_name+stringИмя получателя
    last_name+stringФамилия получателя
    middle_name-stringОтчество получателя
    country_iso3+stringСтрана регистрации получателя по стандарту ISO3166-1 alpha-3
    state-stringРегион или район регистрации получателя
    city+stringНаселенный пункт регистрации получателя
    postal_code-stringПочтовый индекс места регистрации получателя
    street-stringНазвание улицы места регистрации получателя
    building+stringНомер дома места регистрации получателя
    flat-stringКвартира места регистрации получателя
    tax_reference-string12-значный ИНН получателя
    date_of_birth+stringДата рождения получателя. Убедитесь, что возраст получателя 18+
    contacts+objectКонтакты получателя
      phone-objectТелефон получателя
        full_number+stringПолный номер телефона получателя в формате +<код страны><номер>
        country_iso3+stringКод страны, к которой относится номер телефона получателя, в формате ISO3
        operator_code+stringКод оператора телефонного номера получателя
        short_number+stringНомер телефона получателя без кода оператора
      email-stringEmail получателя
    identity_document+objectДанные документа, удостоверяющего личность получателя
      id_type+stringТип документа, удостоверяющего личность получателя. Возможные значения:
— Паспорт иностранного гражданина
— Паспорт гражданина Российской Федерации
      id_number+stringСерия и номер документа, удостоверяющего личность получателя (без пробелов)
      issue_date+stringДата выдачи документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД
      id_expiration_date-stringДата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД. Обязательно для заполнения при наличии в документе.
      division_code-stringКод подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно при наличии в документе
      issued_by-stringНазвание подразделения, выдавшего документ, удостоверяющий личность получателя. Обязательно при наличии в документе
    documents_foreigner-objectПараметры документа получателя-нерезидента. Обязательно, если получатель является иностранным гражданином и выплата происходит в РФ
      id_type+stringТип документа, удостоверяющего личность отправителя-нерезидента. Возможные значения:
— Вид на жительство
— Разрешение на временное проживание
— Миграционная карта
— Виза
      issued_by-stringНазвание органа, выдавшего документ, удостоверяющий личность получателя
      issue_date+stringДата начала срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД
      id_expiration_date+stringДата окончания срока действия документа, удостоверяющего личность получателя, в формате ГГГГ-ММ-ДД
    service_point+objectТочка выдачи денежных средств
      id-stringID точки выдачи
      name-stringНазвание точки выдачи
      country_iso3+stringСтрана точки выдачи. Формат ISO 3166-1 alpha-3
      state-stringРегион/район нахождения точки выдачи
      city+stringНаселенный пункт нахождения точки выдачи
      oktmo-stringКод ОКТМО расположения точки выдачи средств
      street-stringУлица нахождения точки выдачи
      house-stringЗдание нахождения точки выдачи
      terminal_id-stringНомер терминала/кассы
  sender+objectИнформация об отправителе
    citizenship_country_iso3+stringСтрана гражданства отправителя по стандарту ISO3166-1 alpha-3
    first_name+stringИмя отправителя
    last_name+stringФамилия отправителя
    middle_name-stringОтчество отправителя
    contacts+objectКонтакты отправителя
      phone-objectТелефон отправителя
        full_number+stringПолный номер телефона отправителя в формате +<код страны><номер>
        country_iso3+stringКод страны, к которой относится номер телефона отправителя, в формате ISO3
        operator_code+stringКод оператора телефонного номера отправителя
        short_number+stringНомер телефона отправителя без кода оператора
    customer_verificationobjectДанные получателя платежа, указанные при создании транзакции payment
      first_name+stringИмя получателя
      last_name+stringФамилия получателя
      middle_name-stringОтчество получателя
      date_of_birth+stringДата рождения получателя. Убедитесь, что возраст получателя 18+
      contacts+objectКонтакты получателя
        phone-objectТелефон получателя
          full_number+stringПолный номер телефона получателя в формате +<код страны><номер>
          country_iso3+stringКод страны, к которой относится номер телефона получателя, в формате ISO3
          operator_code+stringКод оператора телефонного номера получателя
          short_number+stringНомер телефона получателя без кода оператора
        email-stringEmail получателя
amount_details+objectСумма и валюта к выдаче
  amount+intСумма к выдаче
  currency+stringВалюта к выдаче
error-objectПричина ошибки. Возвращается только если была ошибка по сессии
  description-stringОписание ошибки
  code-stringКод ошибки
Пример успешного ответа

В ответе будет присутствовать объект customer_verification с информацией по данным отправителя. Нужно сверить полученные данные в объекте customer_verification с данными заявителя в документе, удостоверяющем личность. Если данные расходятся, средства не должны быть выданы.

{
  "status": "ok",
  "session": {
    "id": "ps_3230",
    "status": "in_progress",
    "created_at": "2022-11-01T02:03:00.000000Z",
    "updated_at": "2022-11-01T02:03:00.000000Z",
    "payments": [
      {
        "id": "po_2018",
        "status": "in_progress",
        "created_at": "2022-11-01T02:03:00.000000Z",
        "payment_method": {
          "type": "moneysend"
        },
        "participant_details": {
          "recipient": {
            "citizenship_country_iso3": "AUS",
            "first_name": "Ivan",
            "last_name": "Sidorov",
            "middle_name": "Ivanovich",
            "country_iso3": "RUS",
            "state": "New York",
            "city": "Kazan",
            "postal_code": "420000",
            "street": "Nekrasova",
            "building": "1",
            "flat": "131",
            "tax_reference": "123456789012",
            "date_of_birth": "2010-01-01",
            "contacts": {
              "phone": {
                "full_number": "+79377654321",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "7654321"
              },
              "email": "test@test.com"
            },
            "identity_document": {
              "id_type": "Паспорт гражданина Российской Федерации",
              "id_number": "123456789",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01",
              "division_code": "165-065",
              "issued_by": "OVD Kazani"
            },
            "documents_foreigner": {
              "id_type": "Виза",
              "issued_by": "OVD Kazani",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01"
            },
            "service_point": {
              "id": "1",
              "name": "point_on_lenina",
              "country_iso3": "RUS",
              "state": "Moscow",
              "city": "Moscow",
              "oktmo": "36634436111",
              "street": "Lenin avenue",
              "house": "1",
              "terminal_id": "123124"
            },
            "source_of_money": "salary",
            "description": "salary transfers",
            "customer_verification": {
              "first_name": "Ivan",
              "last_name": "Ivanov",
              "middle_name": "Ivanovich",
              "date_of_birth": "2010-01-01",
              "contacts": {
                "phone": {
                  "full_number": "+79371234567",
                  "country_iso3": "RUS",
                  "operator_code": "937",
                  "short_number": "1234567"
                },
                "email": "test@test.com"
              }
            }
          },
          "sender": {
            "first_name": "Ivan",
            "last_name": "Ivanov",
            "middle_name": "Ivanovich",
            "contacts": {
              "phone": {
                "full_number": "+79371234567",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "1234567"
              },
              "email": "test@test.com"
            }
          }
        }
      }
    ]
  }
}
Пример неуспешного ответа 
{
  "error": {
    "code": "invalid_request",
    "description": "participant_details.recipient.full_name.not_blank"
  },
  "status": "error"
}

Вебхук ready_to_confirm​

Дождитесь этого вебхука, чтобы подтвердить или отклонить выплату. Содержание вебхука совпадает с содержанием ответа на запрос cash/payout/session/init.

Пример вебхука 
"type": "ready_to_confirm",
{
  "status": "ok",
  "session": {
    "id": "ps_3230",
    "status": "in_progress",
    "created_at": "2022-11-01T02:03:00.000000Z",
    "updated_at": "2022-11-01T02:03:00.000000Z",
    "payments": [
      {
        "id": "po_2018",
        "status": "in_progress",
        "created_at": "2022-11-01T02:03:00.000000Z",
        "payment_method": {
          "type": "moneysend"
        },
        "participant_details": {
          "recipient": {
            "citizenship_country_iso3": "AUS",
            "first_name": "Ivan",
            "last_name": "Sidorov",
            "middle_name": "Ivanovich",
            "country_iso3": "RUS",
            "state": "New York",
            "city": "Kazan",
            "postal_code": "420000",
            "street": "Nekrasova",
            "building": "1",
            "flat": "131",
            "tax_reference": "123456789012",
            "date_of_birth": "2010-01-01",
            "contacts": {
              "phone": {
                "full_number": "+79377654321",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "7654321"
              },
              "email": "test@test.com"
            },
            "identity_document": {
              "id_type": "Паспорт гражданина Российской Федерации",
              "id_number": "123456789",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01",
              "division_code": "165-065",
              "issued_by": "OVD Kazani"
            },
            "documents_foreigner": {
              "id_type": "Виза",
              "issued_by": "OVD Kazani",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01"
            },
            "service_point": {
              "id": "1",
              "name": "point_on_lenina",
              "country_iso3": "RUS",
              "state": "Moscow",
              "city": "Moscow",
              "oktmo": "36634436111",
              "street": "lenin avenue",
              "house": "1",
              "terminal_id": "123124"
            },
            "source_of_money": "salary",
            "description": "salary transfers",
            "customer_verification": {
              "first_name": "Ivan",
              "last_name": "Ivanov",
              "middle_name": "Ivanovich",
              "date_of_birth": "2010-01-01",
              "contacts": {
                "phone": {
                  "full_number": "+79371234567",
                  "country_iso3": "RUS",
                  "operator_code": "937",
                  "short_number": "1234567"
                },
                "email": "test@test.com"
              }
            }
          },
          "sender": {
            "first_name": "Ivan",
            "last_name": "Ivanov",
            "middle_name": "Ivanovich",
            "contacts": {
              "phone": {
                "full_number": "+79371234567",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "1234567"
              },
              "email": "test@test.com"
            }
          }
        }
      }
    ]
  }
}

Метод POST.../api/v1/session/confirm​

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

После того как Партнер вызовет метод, произойдет подтверждение выплаты, отозвать или отклонить выплату будет невозможно.

Параметры запроса​

НазваниеОбязательностьТип данныхОписание
session_id+stringID сессии из ответа на инициацию транзакции
Пример запроса 
"session_id": "ps_1"

Параметры ответа​

Содержимое ответа совпадает с содержанием ответа на запрос cash/payout/session/init.

Пример ответа 
{
  "status": "ok",
  "session": {
    "id": "ps_3230",
    "status": "in_progress",
    "created_at": "2022-11-01T02:03:00.000000Z",
    "updated_at": "2022-11-01T02:03:00.000000Z",
    "payments": [
      {
        "id": "po_2018",
        "status": "in_progress",
        "created_at": "2022-11-01T02:03:00.000000Z",
        "payment_method": {
          "type": "moneysend"
        },
        "participant_details": {
          "recipient": {
            "citizenship_country_iso3": "AUS",
            "first_name": "Ivan",
            "last_name": "Sidorov",
            "middle_name": "Ivanovich",
            "country_iso3": "RUS",
            "state": "New York",
            "city": "Kazan",
            "postal_code": "420000",
            "street": "Nekrasova",
            "building": "1",
            "flat": "131",
            "tax_reference": "123456789012",
            "date_of_birth": "2010-01-01",
            "contacts": {
              "phone": {
                "full_number": "+79377654321",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "7654321"
              },
              "email": "test@test.com"
            },
            "identity_document": {
              "id_type": "Паспорт гражданина Российской Федерации",
              "id_number": "123456789",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01",
              "division_code": "165-065",
              "issued_by": "OVD Kazani"
            },
            "documents_foreigner": {
              "id_type": "Виза",
              "issued_by": "OVD Kazani",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01"
            },
            "service_point": {
              "id": "1",
              "name": "point_on_lenina",
              "country_iso3": "RUS",
              "state": "Moscow",
              "city": "Moscow",
              "oktmo": "36634436111",
              "street": "Lenin avenue",
              "house": "1",
              "terminal_id": "123124"
            },
            "source_of_money": "salary",
            "description": "salary transfers",
            "customer_verification": {
              "first_name": "Ivan",
              "last_name": "Ivanov",
              "middle_name": "Ivanovich",
              "date_of_birth": "2010-01-01",
              "contacts": {
                "phone": {
                  "full_number": "+79371234567",
                  "country_iso3": "RUS",
                  "operator_code": "937",
                  "short_number": "1234567"
                },
                "email": "test@test.com"
              }
            }
          },
          "sender": {
            "first_name": "Ivan",
            "last_name": "Ivanov",
            "middle_name": "Ivanovich",
            "contacts": {
              "phone": {
                "full_number": "+79371234567",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "1234567"
              },
              "email": "test@test.com"
            }
          }
        }
      }
    ]
  }
}

Метод POST.../api/v1/session/cancel​

Метод предназначен для отмены выдачи денег.

Параметры запроса​

НазваниеОбязательностьТип данныхОписание
session_id+stringID сессии из ответа на инициацию транзакции
Пример запроса 
"session_id": "ps_1"

Параметры ответа​

Содержимое ответа совпадает с содержанием ответа на запрос cash/payout/session/init.

Пример ответа 
{
  "status": "ok",
  "session": {
    "id": "ps_3230",
    "status": "in_progress",
    "created_at": "2022-11-01T02:03:00.000000Z",
    "updated_at": "2022-11-01T02:03:00.000000Z",
    "payments": [
      {
        "id": "po_2018",
        "status": "pending",
        "created_at": "2022-11-01T02:03:00.000000Z",
        "payment_method": {
          "type": "moneysend"
        },
        "participant_details": {
          "recipient": {
            "citizenship_country_iso3": "AUS",
            "first_name": "Ivan",
            "last_name": "Sidorov",
            "middle_name": "Ivanovich",
            "country_iso3": "RUS",
            "state": "New York",
            "city": "Kazan",
            "postal_code": "420000",
            "street": "Nekrasova",
            "building": "1",
            "flat": "131",
            "tax_reference": "123456789012",
            "date_of_birth": "2010-01-01",
            "contacts": {
              "phone": {
                "full_number": "+79377654321",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "7654321"
              },
              "email": "test@test.com"
            },
            "identity_document": {
              "id_type": "Паспорт гражданина Российской Федерации",
              "id_number": "123456789",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01",
              "division_code": "165-065",
              "issued_by": "OVD Kazani"
            },
            "documents_foreigner": {
              "id_type": "Виза",
              "issued_by": "OVD Kazani",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01"
            },
            "service_point": {
              "id": "1",
              "name": "point_on_lenina",
              "country_iso3": "RUS",
              "state": "Moscow",
              "city": "Moscow",
              "oktmo": "36634436111",
              "street": "Lenin avenue",
              "house": "1",
              "terminal_id": "123124"
            },
            "source_of_money": "salary",
            "description": "salary transfers",
            "customer_verification": {
              "first_name": "Ivan",
              "last_name": "Ivanov",
              "middle_name": "Ivanovich",
              "date_of_birth": "2010-01-01",
              "contacts": {
                "phone": {
                  "full_number": "+79371234567",
                  "country_iso3": "RUS",
                  "operator_code": "937",
                  "short_number": "1234567"
                },
                "email": "test@test.com"
              }
            }
          },
          "sender": {
            "first_name": "Ivan",
            "last_name": "Ivanov",
            "middle_name": "Ivanovich",
            "contacts": {
              "phone": {
                "full_number": "+79371234567",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "1234567"
              },
              "email": "test@test.com"
            }
          }
        }
      }
    ]
  }
}

Вебхук payment_finished​

Банк отправляет этот вебхук, когда завершает транзакцию. В теле вебхука приходят все параметры транзакции, в том числе ее статус (в поле status). Содержание вебхука будет равно содержанию ответа на cash/payout/session/init.
Подробнее о вебхуке

Пример вебхука 
"type": "payment_finished",
{
  "status": "ok",
  "session": {
    "id": "ps_3230",
    "status": "accepted",
    "created_at": "2022-11-01T02:03:00.000000Z",
    "updated_at": "2022-11-01T02:03:00.000000Z",
    "payments": [
      {
        "id": "po_2018",
        "status": "succeeded",
        "created_at": "2022-11-01T02:03:00.000000Z",
        "payment_method": {
          "type": "moneysend"
        },
        "participant_details": {
          "recipient": {
            "citizenship_country_iso3": "AUS",
            "first_name": "Ivan",
            "last_name": "Sidorov",
            "middle_name": "Ivanovich",
            "country_iso3": "RUS",
            "state": "New York",
            "city": "Kazan",
            "postal_code": "420000",
            "street": "Nekrasova",
            "building": "1",
            "flat": "131",
            "tax_reference": "123456789012",
            "date_of_birth": "2010-01-01",
            "contacts": {
              "phone": {
                "full_number": "+79377654321",
                "country_iso3": "RUS",
                "operator_code": "937",
                "short_number": "7654321"
              },
              "email": "test@test.com"
            },
            "identity_document": {
              "id_type": "Паспорт гражданина Российской Федерации",
              "id_number": "123456789",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01",
              "division_code": "165-065",
              "issued_by": "OVD Kazani"
            },
            "documents_foreigner": {
              "id_type": "Виза",
              "issued_by": "OVD Kazani",
              "issue_date": "2020-01-01",
              "id_expiration_date": "2030-01-01"
            },
            "service_point": {
              "id": "1",
              "name": "point_on_lenina",
              "country_iso3": "RUS",
              "state": "Moscow",
              "city": "Moscow",
              "oktmo": "36634436111",
              "street": "Lenin avenue",
              "house": "1",
              "terminal_id": "123124"
            },
            "source_of_money": "salary",
            "description": "salary transfers",
            "customer_verification": {
              "first_name": "Ivan",
              "last_name": "Ivanov",
              "middle_name": "Ivanovich",
              "date_of_birth": "2010-01-01",
              "contacts": {
                "phone": {
                  "full_number": "+79371234567",
                  "country_iso3": "RUS",
                  "operator_code": "937",
                  "short_number": "1234567"
                },
                "email": "test@test.com"
              }
            }
          }
        },
        "sender": {
          "first_name": "Ivan",
          "last_name": "Ivanov",
          "middle_name": "Ivanovich",
          "contacts": {
            "phone": {
              "full_number": "+79371234567",
              "country_iso3": "RUS",
              "operator_code": "937",
              "short_number": "1234567"
            },
            "email": "test@test.com"
          }
        }
      }
    ]
  }
}