Structure of payout callback requests

Redoc: Structure of payout callback requests.

Endpoint

POST /api/v1/paymentgate/callback/info/payout/

Description

Example structure of all payout callback requests.

Request Body

{
  "tx": "f17d7f5c-6b4a-47fd-95eb-08086e250473",
  "payout": {
    "amount": 100,
    "currency": {
      "id": 0,
      "title": "Ethereum",
      "char_code": "ETH",
      "num_code": 123
    },
    "description": "string",
    "status": "create",
    "test_mode": true,
    "client_id": "string",
    "created_at": "2024-09-27T11:56:32Z",
    "complete_date": "2024-09-27T11:56:32Z",
    "means_of_payment": {
      "mop_type": {
        "name": "string",
        "code": "string"
      },
      "number": "string",
      "detail": {
        "property1": null,
        "property2": null
      }
    },
    "moderated": true,
    "means_of_payment_type": {
      "name": "string",
      "code": "string"
    }
  },
  "status": "create",
  "currency": {
    "id": 0,
    "title": "Ethereum",
    "char_code": "ETH",
    "num_code": 123
  },
  "amount": 100,
  "created_at": "2024-09-27T11:56:32Z",
  "settings": {
    "id": 100,
    "balances": [
      {
        "name": "string",
        "balance": 100
      }
    ]
  },
  "parts_tx": [
    {
      "tx": "f17d7f5c-6b4a-47fd-95eb-08086e250473",
      "currency": {
        "id": 0,
        "title": "Ethereum",
        "char_code": "ETH",
        "num_code": 123
      }
    }
  ],
  "additional_data": {
    "property1": null,
    "property2": null
  }
}

Parameter	Type	required	Description
tx	string <uuid>	T	Transaction id
payout	object (CallbackPaymentGatePayout)	T	Payout
status	string (TransferStatus)	F	Payout status
currency	object	T	Currency
amount	integer	F	Amount in minor units
created_at	string <date-time>	F	Created date
settings	object (CallbackPaymentGatePayoutGatewaySettings)	T	Payout settings
parts_tx	Array of objects (TransactionShort)	T	Parts of Transaction
additional_data	object or null	F	Additional data

Response

200 OK

No response body