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	1000
currency	integer	Yes	Number code	978
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
payment_method	string or null	No	The method of payment being used for the transaction. Used for some types of withdrawals.	"string"
name	string	No	The customer's name. Used for some types of withdrawals.	"John Smith"
email	string	No	The customer's email. Used for some types of withdrawals.	"user@example.com"
phone	string	No	The customer's phone number. Used for some types of withdrawals.	"string"
country	string	No	The customer's country code. Used for some types of withdrawals. (ISO 3166-1 alpha-2)	"string"
account_number	string	No	The customer's account number. Used for some types of withdrawals.(Wallet number, Bank account number, VPA...)	"12312312312"
bank_account_type	string	No	The customer's bank account type. Used for some types of withdrawals. May be: SAVINGS, CHECKING	"string"
bank_code	string	No	The customer's bank code. Used for some types of withdrawals.	"0001"
bank_name	string	No	The customer's bank name. Used for some types of withdrawals.	"string"
bank_agency	string	No	The customer's bank agency. Used for some types of withdrawals.	"string"
bank_account_number	string	No	The customer's bank account number. Used for some types of withdrawals.	"12312312312"
first_name	string	No	The customer's first name. Used for some types of withdrawals.	"John"
last_name	string	No	The customer's last name. Used for some types of withdrawals.	"Smith"
city	string	No	The customer's city. Used for some types of withdrawals.	"string"
address	string	No	The customer's address. Used for some types of withdrawals.	"123 Main Street, Apt 4B"
holder	string	No	The customer's holder. Used for some types of withdrawals.	"string"
document_number	string	No	The customer's document number. Used for some types of withdrawals.	"111111111"
document_type	string	No	The customer's document type. Used for some types of withdrawals.	"string"
sort_code	string	No	The customer's sort_code (FPS). Used for some types of withdrawals.	"string"
evp_random_key	string	No	The customer's EVP random key. Used for some types of withdrawals.	"string"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 1000,
    "currency": 978,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "payment_method": "string",
    "name": "John Smith",
    "email": "user@example.com",
    "phone": "string",
    "country": "string",
    "account_number": "12312312312",
    "bank_account_type": "string",
    "bank_code": "0001",
    "bank_name": "string",
    "bank_agency": "string",
    "bank_account_number": "12312312312",
    "first_name": "John",
    "last_name": "Smith",
    "holder": "string",
    "city": "string",
    "address": "123 Main Street, Apt 4B",
    "document_number": "111111111",
    "document_type": "string",
    "sort_code": "string",
    "evp_random_key": "string"
}

Response sample

STATUS 201

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