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	404
bank_code	string	Yes	The customer's bank code.	"000000"
buyer	object	Yes	Buyer at the endpoint in JSON format	{"remote_id": "string", "ip": "string"}
phone	string	Yes	The customer's phone.	"254712345678"
payment_method	string	Yes	A code payment method. Mpesa, Airtel, etc	"mpesa"
country	string	Yes	The customer's code country. (ISO 3166-1 alpha-2)	"KE"
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
holder	string	Yes	The customer's name.	"John Smith"
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 account number. Used for some types of withdrawals.(Wallet number, Bank account number, VPA...)	"12312312312"

Request sample

{
    "endpoint": "92b6aee5-54a0-496c-8972-aff1f78010c1",
    "amount": 1000,
    "currency": 404,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "bank_code": "000000",
    "phone": "254712345678",
    "country": "KE",
    "payment_method": "mpesa",
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "holder": "John Smith",
    "first_name": "John",
    "last_name": "Smith"
    "account_number": "12312312312",
}

Response sample

STATUS 201

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