Skip to content

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 170
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"
account_no string Yes The customer's account number. "12312312312"
payment_method string Yes Payment method type.
May be: papara, mft, fastpay, vip, parolapara, direct, mypayz, cepbank		 "vip"
document_number string Yes The customer's official identification number assigned by a government authority "111111111"
email string Yes The customer's email. "user@example.com"
phone string Yes The customer's phone. "05111231212"
username string Yes The customer's username "testusername"
birth_date string Yes The customer's birth date. "1990-08-09"
iban string Yes The customer's bank iban. "00000"
branch_no string No The customer's branch number. Required for cepbank. "234535345"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 1000,
    "currency": 170,
    "payment_method": "string",
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "name": "John Smith",
    "document_number": "111111111",
    "birth_date": "1990-08-09",
    "phone": "05111231212",
    "username": "testusername",
    "email": "user@example.com",    
    "iban": "000000"
}

Response sample


STATUS 201

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