get https://uat.inovapay.com/direct///
The Gateway In method serves as the initial point of contact for incoming data, responsible for validating the information transmitted to the API.
Params (before JWT-encoding)
| Parameter | Type | Description |
|---|---|---|
| name | (required, string) | The 'name' field/parameter contains customer data and is mandatory. Once provided, it will be displayed on the form and cannot be modified by the user. |
| (required, string) | The 'email' parameter contains customer data and is mandatory. Once provided, it will be displayed on the form and cannot be modified by the user. | |
| cpf | (required, string) | The 'cpf’' parameter contains customer data and is mandatory. Once provided, it will be displayed on the form and cannot be modified by the user. |
| paymentMethod | (optional, string) | The paymentMethod parameter specifies the chosen deposit method, which can be these following: [banco-do-brasil, bradesco, caixa, santander, pix]. This parameter is optional, but once included in the API call, it cannot be modified by the user. |
| amount | (number, string) | The 'amount' parameter represents the value of the deposit and cannot be changed by the user. |
| currency | (required, string) | The ‘currency’ parameter indicates the payment currency. The only option available is BRL (Brazilian Real), in ISO 4217 format. Once defined, it cannot be changed by user. |
| reference | (required, string) | The ‘reference’ parameter sets a reference code for payment, which is associated with transaction created by payment. This code is useful for linking Bazk/Inovapay transactions to sales identifiers stored in your system. |
| merchant_user | (required, string) | The 'merchant_user' parameter identifies the user on your system, which can be an ID or a username associated with the merchant. |
| country | (required, string) | The 'country' parameter specifies the user's country configured on merchant cashier, formatted according to ISO 3166 standards. |
| return_url | (optional, string) | The return_url parameter is an HTTPS URL used to redirect customer to the merchant's cashier after completing a transaction. |
| brand | (optional, string) | The 'brand' parameter is defined by merchant and is used to identify a specific product or brand within their inventory. |
| phone | (optional, string) | The 'phone' parameter should follow the suggested format: (51)9999-999, where (51) represents the area code. It is limited to a maximum of 45 characters. |
{
"iat": 1712175617,
"exp": 1712175677,
"data": {
"name": "",
"email": "",
"cpf": "",
"paymentMethod": "",
"amount": 0,
"currency": "BRL",
"reference": "",
"merchant_user": "",
"country": "BR",
"return_url": "",
"brand": "",
"phone": ""
}
}