Создание выплаты

Для создания заявок на выплату используется следующий запрос:

POST https://api.transavex.com/api/v1/payout/create

В теле запроса необходимо передавать следующие поля

Поле	Тип	Описание	Пример
paymentId	UUIDv4	ID заявки в вашей системе	11111111-1111-1111-1111-111111111111
client.id	UUIDv4	ID клиента в вашей системе	22222222-2222-2222-2222-222222222222
client.ip	string	IP адрес клиента	90.0.12.111
client.email	string	email адрес клиента	[email protected]
client.tin	string (обязательно для PIX_OUT_* методов)	ИНН	brazil TIN number
amount	number	Сумма платежа	1000
country	string	Код страны платежа (ISO 3166-1 alpha-2)	RU
paymentMethod	string	Название платежного метода	Card
trafficType	string	Тип трафика (ALL / FTD / STD)	ALL
bankId	number (optional)	Используется для метода СБП	31
payoutDetails.ccNo	string (optional)	Номер карты	4627342642639018
payoutDetails.ccHolderName	string (optional)	Имя владельца с карты	John Doe
payoutDetails.ccExpirationMonth	string (optional)	Месяц истечения срока карты	09
payoutDetails.ccExpirationYear	string (optional)	Год истечения срока карты	26
payoutDetails.phoneNumber	string (optional)	Номер телефона для СБП	79999999999
payoutDetails.payeeName	string (optional)	Имя получателя для метода СБП	Иванов Иван
payoutDetails.bankAccountNo	string (optional)	Номер банковского счета	457575757457457
postbackUrl	string	URL на который мы отправил вам POST вебхук	https://...

Поля объекта payoutDetails формируются в зависимости от выбранного клиентом платежного метода:

• Card - ccNo, ccHolderName, ccExpirationMonth и ccExpirationYear - обязательны.
• SBP - phoneNumber - обязателен.
• BankAccount - bankAccountNo - обязателен.

Пример запроса (метод Card)

curl --request POST \
--url 'https://api.transavex.com/api/v1/payout/create' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: {{token}}' \
--header 'X-Signature: {{signature}}' \
-d '{
    "paymentId": "11111111-1111-1111-1111-111111111111",
    "client": {
        "id": "22222222-2222-2222-2222-222222222222",
        "ip": "90.0.12.111",
        "email": "[email protected]"
    },
    "amount": 8000,
    "country": "RU",
    "paymentMethod": "Card",
    "trafficType": "ALL",
    "payoutDetails": {
        "ccNo": "4627342642639018",
        "ccHolderName": "John Doe",
        "ccExpirationMonth": "09",
        "ccExpirationYear": "26"
    }
}'

Пример запроса (метод SBP)

curl --request POST \
--url 'https://api.transavex.com/api/v1/payout/create' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: {{token}}' \
--header 'X-Signature: {{signature}}' \
-d '{
    "paymentId": "11111111-1111-1111-1111-111111111111",
    "client": {
        "id": "22222222-2222-2222-2222-222222222222",
        "ip": "90.0.12.111",
        "email": "[email protected]"
    },
    "amount": 8000,
    "country": "RU",
    "paymentMethod": "SBP",
    "trafficType": "ALL",
    "bankId": 31,
    "payoutDetails": {
        "phoneNumber": "9999999999",
        "payeeName": "Иванов Иван"
    }
}'

Пример запроса (метод PIX_OUT_CPF)

curl --request POST \
--url 'https://api.transavex.com/api/v1/payout/create' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: {{token}}' \
--header 'X-Signature: {{signature}}' \
-d '{
    "paymentId": "11111111-1111-1111-1111-111111111111",
    "client": {
        "id": "22222222-2222-2222-2222-222222222222",
        "ip": "90.0.12.111",
        "email": "[email protected]",
        "phone": "553030000721",
        "tin": "some TIN number"
    },
    "amount": 100,
    "country": "BR",
    "paymentMethod": "PIX_OUT_CPF",
    "trafficType": "ALL"
}'

Пример запроса (метод PIX_OUT_EMAIL)

curl --request POST \
--url 'https://api.transavex.com/api/v1/payout/create' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: {{token}}' \
--header 'X-Signature: {{signature}}' \
-d '{
    "paymentId": "11111111-1111-1111-1111-111111111111",
    "client": {
        "id": "22222222-2222-2222-2222-222222222222",
        "ip": "90.0.12.111",
        "email": "[email protected]",
        "phone": "553030000721"
    },
    "amount": 100,
    "country": "BR",
    "paymentMethod": "PIX_OUT_EMAIL",
    "trafficType": "ALL"
}'

Пример запроса (метод PIX_OUT_PHONE)

curl --request POST \
--url 'https://api.transavex.com/api/v1/payout/create' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: {{token}}' \
--header 'X-Signature: {{signature}}' \
-d '{
    "paymentId": "11111111-1111-1111-1111-111111111111",
    "client": {
        "id": "22222222-2222-2222-2222-222222222222",
        "ip": "90.0.12.111",
        "email": "[email protected]",
        "phone": "553030000721"
    },
    "amount": 100,
    "country": "BR",
    "paymentMethod": "PIX_OUT_PHONE",
    "trafficType": "ALL"
}'

Пример запроса (метод PIX_OUT_EVP)

curl --request POST \
--url 'https://api.transavex.com/api/v1/payout/create' \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: {{token}}' \
--header 'X-Signature: {{signature}}' \
-d '{
    "paymentId": "11111111-1111-1111-1111-111111111111",
    "client": {
        "id": "22222222-2222-2222-2222-222222222222",
        "ip": "90.0.12.111",
        "email": "[email protected]",
        "phone": "553030000721"
    },
    "amount": 100,
    "country": "BR",
    "paymentMethod": "PIX_OUT_EVP",
    "trafficType": "ALL",
    "payoutDetails": {
        "evp": "evp string from bank"
    }
}'

Пример ответа

{
    "id": "8594c7b6-373c-4baa-a5ee-b5b5bf462d85",
    "status": "In progress"
}