Pay out order creation

Use the following POST request to create a pay out order:

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

The following fields have to be passed as a request body (optionals are marked):

Field	Type	Description	Example
paymentId	UUIDv4	Your system's unique id	11111111-1111-1111-1111-111111111111
client.id	UUIDv4	Your client's unique id	22222222-2222-2222-2222-222222222222
client.ip	string	IP of your client	90.0.12.111
client.email	string	email of your client	[email protected]
client.tin	string (required for PIX_OUT_* methods)	Brazil TIN	brazil TIN number
amount	number	Payment amount	1000
country	string	Country code (ISO 3166-1 alpha-2)	RU
paymentMethod	string	Payment method	Card
trafficType	string	Client traffic type (ALL / FTD / STD)	ALL
bankId	number (optional)	Must be used in combination with SBP method	31
payoutDetails.ccNo	string (optional)	Card number	4627342642639018
payoutDetails.ccHolderName	string (optional)	Card holder name	John Doe
payoutDetails.ccExpirationMonth	string (optional)	Card expiration month	09
payoutDetails.ccExpirationYear	string (optional)	Card expiration year	26
payoutDetails.phoneNumber	string (optional)	SBP bound phone number	79999999999
payoutDetails.payeeName	string (optional)	Receiver's name for SBP method	John Doe
payoutDetails.bankAccountNo	string (optional)	Bank account number	457575757457457
postbackUrl	string	The URL we POST a callback to you at	https://...

payoutDetails are provided according to the payment method of your client's choice:

• Card - ccNo, ccHolderName, ccExpirationMonth и ccExpirationYear - required.
• SBP - phoneNumber - required. payeeName is also required but left optional for compatibility.
• BankAccount - bankAccountNo - required.

Request example (Card method)

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": "US",
    "paymentMethod": "Card",
    "trafficType": "ALL",
    "payoutDetails": {
        "ccNo": "4627342642639018",
        "ccHolderName": "John Doe",
        "ccExpirationMonth": "09",
        "ccExpirationYear": "30"
    }
}'

Request example (SBP method)

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": "US",
    "paymentMethod": "SBP",
    "trafficType": "ALL",
    "bankId": 31,
    "payoutDetails": {
        "phoneNumber": "9999999999",
        "payeeName": "John Doe"
    }
}'

Request example (метод 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"
}'

Request example (метод 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"
}'

Request example (метод 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"
}'

Request example (метод 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"
    }
}'

Response example

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