Pay in order creation

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

POST https://api.transavex.com/api/v1/payin/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.phone	string (optional)	Phone number of your client	79999999999
client.firstName	string (optional)	Client's first name	John
client.lastName	string (optional)	Client's last name	Doe
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
postbackUrl	string	The URL we POST a callback to you at	https://...
bankId	number (optional)	This can be used to specify inner methods if applicable (alpha-alpha, sber-sber, ...) (We have a api/v1/bank/available?country=<alpha-2> method to retrieve banks)	12
addRandomCents	boolean (optional)	Whether you want us to add random cents to the amount	true

Request example

curl --request POST \
--url 'https://api.transavex.com/api/v1/payin/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": "199999999",
        "firstName": "John",
        "lastName": "Doe"
    },
    "amount": 8000,
    "country": "US",
    "paymentMethod": "Card",
    "trafficType": "ALL"
}'

Card / CrossBorderCard response example

{
    "status": "In progress",
    "id": "9c7ffb7b-6d81-4321-ae6f-515f7140d484",
    "expiresAt": "2025-05-16T18:05:23Z",
    "bankDetails": {
        "card": {
            "cardNumber": "2202206137337635",
            "cardHolderName": "John Doe"
        },
        "bankName": "CITIBANK"
    }
}

SBP / CrossBorderSBP response example

{
    "status": "In progress",
    "id": "9c7ffb7b-6d81-4321-ae6f-515f7140d484",
    "expiresAt": "2025-05-16T18:05:23Z",
    "bankDetails": {
        "phoneNumber": "79149000186",
        "bankName": "CITIBANK",
        "payeeName": "John Doe"
    }
}

QRNSPK/QRNSPKCrossBorder response example

qr object model:

{
    // Could be a url
    url?: string;
    // Or a code to generate QR image
    code?: string;
    // Or both
}

{
    "status": "In progress",
    "id": "9c7ffb7b-6d81-4321-ae6f-515f7140d484",
    "expiresAt": "2025-05-16T18:05:23Z",
    "bankDetails": {
        "qr": {
            "url": "...url to qr code...",
            "code": "...code to generate qr image..."
        },
        "bankName": "CITIBANK",
        "bankId": 1123
    }
}

PIX response example

qr object model:

{
    // Code to generate QR image
    code?: string;
}

{
    "status": "In progress",
    "id": "9c7ffb7b-6d81-4321-ae6f-515f7140d484",
    "expiresAt": "2025-05-16T18:05:23Z",
    "bankDetails": {
        "qr": {
            "code": "...code to generate qr image..."
        },
        "bankName": "Banco do Brasil",
        "bankId": 1123
    }
}