Create payout

Endpoint

POST /api/v1/paymentgate/payout/simple/

Description

Record and process payout in system and return transaction info.

Request Body

{
  "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
  "module": 100,
  "amount": 100,
  "currency": "string",
  "description": "string",
  "client_id": "string",
  "notify_url": "http://example.com",
  "moderated": true,
  "account_number": "string",
  "payment_method": "string",
  "buyer": {
    "remote_id": "string",
    "ip": "string"
  }
}

Parameter	Type	required	Description
endpoint	string *<uuid>*	T	Endpoint API Key
module	integer	F	Payout module ID
amount	integer *>= 1*	T	Amount in minor units
currency	string	T	Receipt currency (char code, example: ETH)
description	string	F	Description
client_id	string	F	Transaction id at the endpoint
notify_url	string or null *<uri>*	F	Notification URL of changed status
moderated	boolean or null	F	Is payout moderated?
account_number	string or null	T	Account number in endpoint system
payment_method	string	T	Payout method type
buyer	object	F	Buyer at the endpoint

Response

201 Created

{
  "tx": {
    "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": {
          "id": 100,
          "name": "string",
          "code": "string"
        },
        "number": "string",
        "detail": {
          "property1": null,
          "property2": null
        }
      },
      "moderated": true,
      "means_of_payment_type": {
        "id": 100,
        "name": "string",
        "code": "string"
      },
      "language": {
        "id": 100,
        "name": "string",
        "code": "string"
      },
      "merchant_fee_amount": 0
    },
    "status": "create",
    "currency": {
      "id": 0,
      "title": "Ethereum",
      "char_code": "ETH",
      "num_code": 123
    },
    "amount": 100,
    "created_at": "2024-09-27T11:56:32Z",
    "additional_data": {
      "property1": null,
      "property2": null
    },
    "endpoint_logo": "string"
  }
}