Skip to content

B2C

POST api/v2/paygate/payout/card/
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 944
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
holder string Yes Card holder "string"
pan string No Card primary account number (PAN).
Used for some types of withdrawals.
"4200000000000000"
bank_code string Yes The customer's bank code. "0000000"
card_token string No Card token in our system.
Used for some types of withdrawals.
"string"
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": 944,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "holder": "string",
    "pan": "4200000000000000",
    "bank_code": "0000000",
    "card_token": "string",
    "exp_year": 2030,
    "exp_month": 12
}

Response sample


STATUS 201

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