Skip to main content

Paying out and refunding funds

On this page you will find the methods and webhooks that the payment partner will need to pay out the funds to the recipient if the transfer is successful or to refund the funds to the sender.

Please note that the transferred funds can only be paid out and refunded in full.

The main scenario of requests is as follows:

  1. If the transferred funds are paid out abroad, the Bank will notify the payment partner of the successful payout completion. The payment partner must be able to correctly process this notification. If needed, the payment partner can contact the Bank manager and deactivate this notification.
  2. The recipient contacts the payment partner with the passport and transfer code received when the transfer was made.
  3. The payment partner initiates a payout session and sends to the Bank information on the Recipient.
  4. The Bank creates a transaction and returns the creation results.
  5. After receiving the response, wait for a ready_to_confirm webhook with detailed information on the payout amount and recipient.
  6. Once a ready_to_confirm webhook is received, confirm the transaction with session/confirm or cancel it with session/cancel.
  7. To complete the transaction, wait for a payment_finished webhook.

Sequence diagram of paying out funds​

Sequence diagram of paying out funds

transaction_registration webhook​

When the transferred funds are successfully paid out abroad, the Bank will send the payment partner a transaction_registration webhook to which the partner must send a response.
The webhook will contain the following essential information:

  • the parent session within which the funds were accepted (session_payment_id)
  • the payout session (current) within which the funds were paid out (session_id)
  • the amount paid out

If required, the payment partner can deactivate this webhook. To do this, please contact your Bank 131 manager.

Parameters of the webhook​

NameMandatoryTypeDescription
session_payment_id+stringPayment session ID
session+objectSession details
  id+stringPayout session ID
  status+stringCurrent session status. The available values
  created_at+stringSession creation date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
  updated_at+stringSession update date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
  error-objectError details. Returned only if an error occurred
    description-stringError description
    code-stringError code
  payments+arrayPayment details
    id+stringPayment ID
    status+stringCurrent payment status. The available values
    created_at+stringPayment creation date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
    finished_at-stringPayment finalization date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
    payment_method+objectPayment method
      type+stringPayment method name. Valid value: moneysend
    amount_details+objectamount_details object sent in the request
      amount+intAmount in minor values
      currency+stringCurrency
    paymentMetadata-objectAdditional metadata
      parentSessionId-stringPayment session ID
    participant_details+objectInformation on the sender and recipient. The object is guaranteed. All the keys and nested objects are not guaranteed
      sender-objectSender details. The object is guaranteed. All the keys and nested objects are not guaranteed
      recipient-objectRecipient details. The object is guaranteed. All the keys and nested objects are not guaranteed
    error-objectTransaction error details. Returned only if an error occurred
      description-stringError description
      code-stringError code
Webhook example 
{
  "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"
              }
            }
          }
        }
      }
    ]
  }
}

Response parameters​

NameMandatoryTypeDescription
status+stringRegistration status. Valid values:
succeeded — successfully registered
failed — registration failed
already — the record already exists
status_details+stringDetailed information on the registration status
Response example 
{
  "status": "failed",
  "status_details": "No such session_payment_id: ps_948536"
}

POST…/api/v1/cash/payout/session/init method​

This method is used to initiate the payout of funds to the recipient or refund of the transfer to the sender. The set of parameters is the same in both cases. To refund the transfer to the sender, pass the same details for the sender (participant_details.sender) and the recipient (participant_details.recipient) of the transfer in the request.

Note that the received transfer code must be wrapped in BASE64 and put in the tcn_code_encoded parameter.

Request parameters​

NameMandatoryTypeDescription
tcn_code_encoded+stringTransaction code received from the recipient and wrapped in BASE64. Example: MzU4MDctMjM1ODk=
payment_method+objectPayment method
  type+stringPayment method name. Valid value: moneysend
  moneysend+objectDetails of payment via Moneysend
amount_details+objectPayment details
  amount+intPayout amount
  currency+stringPayment currency
participant_details+objectParticipant details
  recipient+objectRecipient details
    citizenship_country_iso3+stringRecipient's country of citizenship according to ISO3166-1 alpha-3
    first_name+stringRecipient's first name
    last_name+stringRecipient's last name
    middle_name-stringRecipient's patronymic
    country_iso3+stringRecipient's country of registration according to ISO 3166-1 alpha-3
    state-stringState or region of the recipient's place of registration
    city+stringLocality of the recipient's place of registration
    postal_code-stringPostal code of the recipient's place of registration
    street-stringStreet of the recipient's place of registration
    building+stringBuilding number of the recipient's place of registration
    flat-stringApartment of the recipient's place of registration
    tax_reference-stringRecipient's INN (12 digits)
    date_of_birth+stringRecipient's date of birth in the YYYY-MM-DD format. Make sure the recipient is 18 years old or older
    contacts+objectRecipient's contacts
      phone-objectRecipient's phone number
        full_number+stringRecipient's full phone number in the +<country code><number> format
        country_iso3+stringRecipient's phone number country code according to ISO3
        operator_code+stringOperator code of the recipient's phone number
        short_number+stringRecipient's phone number without the operator code
      email-stringRecipient's email
    identity_document+objectRecipient's identity document
      id_type+stringType of the recipient's identity document. Valid values:
— Passport of a foreign citizen
— Passport of a citizen of the Russian Federation
      id_number+stringRecipient's identity document series and number (without spaces)
      issue_date+stringRecipient's identity document issue date in the YYYY-MM-DD format
      id_expiration_date-stringRecipient's identity document expiry date in the YYYY-MM-DD format. Required if available in the document. Otherwise, do not send this field
      division_code-stringCode of the division that issued the recipient's identity document. Required if available in the document
      issued_by-stringName of the division that issued the recipient's identity document. Required if available in the document
    documents_foreigner-objectNon-resident recipient's identity document details. Required if the recipient is not a resident and the funds are paid out within the Russian Federation
      id_type+stringType of the non-resident recipient's identity document. Valid values:
— Residence permit
— Temporary residence permit
— Migration card
— Visa
      issued_by-stringNon-resident recipient's identity document issuing authority
      issue_date+stringNon-resident recipient's identity document issue date in the YYYY-MM-DD format
      id_expiration_date+stringNon-resident recipient's identity document expiry date in the YYYY-MM-DD format
    service_point+objectService point of accepting funds
      id-stringService point ID
      name-stringService point name
      country_iso3+stringService point country according to ISO 3166-1 alpha-3
      state-stringService point region/state
      city+stringService point locality
      oktmo-stringService point OKTMO
      street-stringService point street
      house-stringService point building
      terminal_id-stringTerminal/cash register ID
    source_of_money-stringSource of the sender's funds
    description-stringAdditional information
  sender+objectSender details
    citizenship_country_iso3+stringSender's country of citizenship according to ISO 3166-1 alpha-3
    first_name+stringSender's first name
    last_name+stringSender's last name
    middle_name-stringSender's patronymic
    contacts+objectSender's contacts
      phone-objectSender's phone number
        full_number+stringSender's full phone number in the +<country code><number> format
        country_iso3+stringSender's phone number country code according to ISO3
        operator_code+stringOperator code of the sender's phone number
        short_number+stringSender's phone number without the operator code
      email-stringSender's email
cash_details+objectAdditional information on the cash payment
  shift+stringCash register shift
Request example 
{
  "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"
      }
    }
  }
}

Response parameters​

NameMandatoryTypeDescription
status+stringRequest status
session+objectSession details
  id+stringSession ID. Remember it to use it to confirm/cancel the transaction or to get the transaction status
  status+stringCurrent session status. The available values
  created_at+stringSession creation date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
  updated_at+stringSession update date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
  error-objectError details. Returned only if an error occurred
    description-stringError description
    code-stringError code
  payments+arrayPayment details
    id+stringPayment ID
    status+stringCurrent payment status. The available values
    created_at+stringPayment creation date and time in the RFC 3339 format. Example: 2022-11-15T15:38:50.255803Z
  payment_method+objectPayment method
    type+stringPayment method name. Valid value: moneysend
    participant_details+objectpayment_details sent in the request
  recipient+objectRecipient details
    citizenship_country_iso3+string Recipient's country of citizenship according to ISO3166-1 alpha-3
    first_name+stringRecipient's first name
    last_name+stringRecipient's last name
    middle_name-stringRecipient's patronymic
    country_iso3+stringRecipient's country of registration according to ISO 3166-1 alpha-3
    state-stringState or region of the recipient's place of registration
    city+stringLocality of the recipient's place of registration
    postal_code-stringPostal code of the recipient's place of registration
    street-stringStreet of the recipient's place of registration
    building+stringBuilding number of the recipient's place of registration
    flat-stringApartment of the recipient's place of registration
    tax_reference-stringRecipient's INN (12 digits)
    date_of_birth+stringRecipient's date of birth in the YYYY-MM-DD format. Make sure the recipient is 18 years old or older
    contacts+objectRecipient's contacts
      phone-objectRecipient's phone number
        full_number+stringRecipient's full phone number in the +<country code><number> format
        country_iso3+stringRecipient's phone number country code according to ISO3
        operator_code+stringOperator code of the recipient's phone number
        short_number+stringRecipient's phone number without the operator code
      email-stringRecipient's email
    identity_document+objectRecipient's identity document
      id_type+stringType of the recipient's identity document. Valid values:
— Passport of a foreign citizen
— Passport of a citizen of the Russian Federation
      id_number+stringRecipient's identity document series and number (without spaces)
      issue_date+stringRecipient's identity document issue date in the YYYY-MM-DD format
      id_expiration_date-stringRecipient's identity document expiry date in the YYYY-MM-DD format. Required if available in the document. Otherwise, do not send this field
      division_code-stringCode of the division that issued the recipient's identity document. Required if available in the document
      issued_by-stringName of the division that issued the recipient's identity document. Required if available in the document
    documents_foreigner-objectNon-resident recipient's identity document details. Required if the recipient is not a resident and the funds are paid out within the Russian Federation
      id_type+stringType of the non-resident recipient's identity document. Valid values:
- Residence permit
- Temporary residence permit
- Migration card
- Visa
      issued_by-stringNon-resident recipient's identity document issuing authority
      issue_date+stringNon-resident recipient's identity document issue date in the YYYY-MM-DD format
      id_expiration_date+stringNon-resident recipient's identity document expiry date in the YYYY-MM-DD format
    service_point+objectService point of accepting funds
      id-stringService point ID
      name-stringService point name
      country_iso3+stringService point country according to ISO 3166-1 alpha-3
      state-stringService point region/state
      city+stringService point locality
      oktmo-stringService point OKTMO
      street-stringService point street
      house-stringService point building
      terminal_id-stringTerminal/cash register ID
    source_of_money-stringSource of the sender's funds
    description-stringAdditional information
  sender+objectSender details
    citizenship_country_iso3+stringSender's country of citizenship according to ISO 3166-1 alpha-3
    first_name+stringSender's first name
    last_name+stringSender's last name
    middle_name-stringSender's patronymic
    contacts+objectSender's contacts
      phone-objectSender's phone number
        full_number+stringSender's full phone number in the +<country code><number> format
        country_iso3+stringSender's phone number country code according to ISO3
        operator_code+stringOperator code of the sender's phone number
        short_number+stringSender's phone number without the operator code
    customer_verificationobjectRecipient details specified when the payment transaction was created
      first_name+stringRecipient's first name
      last_name+stringRecipient's last name
      middle_name-stringRecipient's middle name
      date_of_birth+stringRecipient's date of birth. Make sure the recipient is 18 years old or older
      contacts+objectRecipient's contacts
        phone-objectRecipient's phone number
          full_number+stringRecipient's full phone number in the +<country code><number> format
          country_iso3+stringRecipient's phone number country code according to ISO3
          operator_code+stringOperator code of the recipient's phone number
          short_number+stringRecipient's phone number without the operator code
        email-stringRecipient's email
amount_details+objectPayout details
  amount+intPayout amount
  currency+stringPayout currency
error-objectError details. Returned only if an error occurred
  description-stringError description
  code-stringError code
Successful response example

The response will contain the customer_verification object with information on the sender. Compare the data sent within customer_verification with the data in the recipient's identity document. If the data mismatches, the funds must not be paid out.

{
  "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"
            }
          }
        }
      }
    ]
  }
}
Unsuccessful response example 
{
  "error": {
    "code": "invalid_request",
    "description": "participant_details.recipient.full_name.not_blank"
  },
  "status": "error"
}

ready_to confirm webhook​

Wait for this webhook to confirm or cancel the payout. The webhook contents are identical to the contents of the response to cash/payout/session/init.

Webhook example 

"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 method​

This method is used to confirm the payout after a ready_to_confirm webhook is received meaning that the recipient agreed with the payout amount.

Once the payment partner calls this method, the payout gets confirmed and cannot be revoked or canceled.

Request parameters​

NameMandatoryTypeDescription
session_id+stringSession ID from the response to session/init
Request example 
"session_id": "ps_1"

Response parameters​

The response contents are identical to the contents of the response to cash/payout/session/init.

Response example 
{
  "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 method​

The method is used to cancel the payout.

Request parameters​

NameMandatoryTypeDescription
session_id+stringSession ID from the response to session/init
Request example 
"session_id": "ps_1"

Response parameters​

The response contents are identical to the contents of the response to cash/payout/session/init.

Response example 
 {
  "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 webhook​

The Bank sends this webhook to finalize a transaction. The webhook body contains all the transaction parameters including its status (in the status field). The webhook contents are identical to the contents of the response to cash/payout/session/init.
More about the webhook

Webhook example 
"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"
          }
        }
      }
    ]
  }
}