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	"1dc4441f-38d5-42b5-a705-81958f928462"
amount	integer	Yes	Amount in minor units	100
currency	integer	Yes	Number code	484
buyer	object	Yes	Buyer at the endpoint in JSON format	{"remote_id": "string", "ip": "string"}
description	string	No	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
name	string	Yes	The customer's name	"John Smith"
email	string	Yes	The customer's email	"user@example.com"
country	string	Yes	The customer's country (ISO 3166-1 alpha-2)	"MX"
phone	string	No	The customer's phone number in international format (E164)	"+52999999999"
account_number	string	Yes	The customer's account number. Used for some types of withdrawals.(Wallet number, Bank account number, VPA...)	"12312312312"
document_number	string	Yes	The customer's official identification number assigned by a government authority	"111111111"
document_type	string	Yes	The customer's document type. The customer's document type. May be: CURP/RFC/PASS	"CURP"
bank_account_type	string	Yes	The customer's bank account type. May be: SAVINGS, CHECKING	"CHECKING"
bank_code	string	Yes	The customer's bank code	"0001"
bank_agency	string	No	The customer's bank agency	"string"
bank_name	string	No	The customer's bank name	"string"
payment_method	string	Yes	Payment method	"bank_transfer"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 100,
    "currency": 484,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "name": "John Smith",
    "email": "user@example.com",
    "country": "MX",
    "phone": "+52999999999",
    "account_number": "12312312312",
    "document_number": "111111111",
    "document_type": "CURP",
    "bank_account_type": "CHECKING",
    "bank_code": "0001",
    "bank_agency": "string",
    "bank_name": "string",
    "payment_method": "bank_transfer"
}

Response sample

STATUS 201

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