Create payout

POST api/v2/paygate/payout/wallet/
Create a payout by wallet

Request Body schema

application/json

Field	Type	Required	Description	Example
endpoint	string	Yes	Api key	"92b6aee5-54a0-496c-8972-aff1f78010c1"
amount	integer	Yes	Amount in minor units	1000
currency	integer	Yes	Number code	504
description	string	Yes	Description	"string"
client_id	string	No	Transaction id at the endpoint. Max 255 chars	"string"
notify_url	string or null	No	Notification URL of changed status	"http://example.com"
moderated	boolean or null	No	Is payout moderated? Default: True	True
first_name	string	Yes	The customer's first name.	"John"
last_name	string	Yes	The customer's last name.	"Smith"
account_number	string	Yes	The customer's document number. Used for some types of withdrawals.(Wallet number, Bank account number, VPA...)	"0690000005"
document_number	string	Yes	The customer's document number.	"12235"
document_type	string	Yes	The customer's document type.	"PASSPORT"
document_issued_country	string	Yes	The customer's document issued date.	"US"
document_issued_date	string	Yes	The customer's document issued date.	"2023-12-03"
document_end_date	string	Yes	The customer's document end date.	"2025-10-31"
bank_name	string	Yes	The customer's bank name.	"AL BARID BANK"
country	string	Yes	The customer's country. (ISO 3166-1 alpha-2)	"MA"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 1000,
    "currency": 504,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "first_name": "John",
    "last_name": "Smith",
    "account_number": "454454545",
    "document_number": "12235",
    "document_type": "PASSPORT",
    "document_issued_country": "US",
    "document_issued_date": "2023-12-03",
    "document_end_date": "2025-10-31",
    "bank_name": "AL BARID BANK",
    "country": "MA"
}

Response sample

STATUS 201

{
    "tx": {
        "tx": "f17d7f5c-6b4a-47fd-95eb-08086e250473",
        "payout": {},
        "status": "create",
        "currency": {
          "id": 0,
          "title": "MAD",
          "char_code": "MAD",
          "num_code": 504
        },
        "amount": 1000,
        "created_at": "2000-01-01T00:00:00Z",
        "errors": {},
        "parts_tx": [],
        "additional_data": {},
        "endpoint_logo": "string"
    }
}