Skip to main content

Processing a successful payout notification

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 the Bank manager.

Parameters of the transaction_registration webhook

NameMandatoryTypeDescription
session_payment_id+stringPayment session ID
session+objectSession details
  id+stringPayout session ID
  status+stringCurrent session status. See the available values here
  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. See the available values here
    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+floatAmount 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"
}