Create payout

POST api/v2/paygate/payout/card/create/
Create a card payout

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
pan	string	No	Card primary account number (PAN). Used for some types of withdrawals.	"4200000000000000"
card_token	string	No	Card token in our system. Used for some types of withdrawals.	"string"
holder	string	No	The customer's name (holder or first_name and last_name is required).	"John Smith"
first_name	string	No	The customer's first name (holder or first_name and last_name is required).	"John"
last_name	string	No	The customer's last name (holder or first_name and last_name is required).	"Smith"
exp_year	integer	Yes	Card expire year.	2030
exp_month	integer	Yes	Card expire month.	12

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",
    "pan": "4200000000000000",
    "card_token": "string",
    "holder": "John Smith",
    "first_name": "John",
    "last_name": "Smith",
    "exp_year": 2030,
    "exp_month": 12
}

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"
    }
}