Payment Initiation ITP

The Payment Initiation (ITP) feature facilitates seamless integration of Payment Initiation into merchants' websites or applications. Merchants receive transaction data and a unique URL from the initiator, allowing users to securely make payments directly from their bank accounts. This streamlines transactions, eliminating traditional methods like credit cards.

Params (before JWT-encoding)

Parameter	Type	Description
name	(required, string)	The 'name' parameter represents the user's name. If left blank, the deposit form will display the field as editable, allowing the user to input their name.
email	(required, string)	The 'email' parameter represents the user's email address. If left blank or if the provided email address is invalid, the corresponding field in the deposit form can be manually edited by the user.
cpf	(required, string)	The 'CPF' parameter represents the user's CPF (Brazilian tax number). If left blank or if the provided CPF is invalid, the corresponding field in the deposit form can be manually edited by the user.
amount	(number, string)	The 'amount' parameter represents the value of the deposit and cannot be modified by the user.
currency	(required, string)	The 'currency' parameter specifies the currency used for the deposit, with BRL (Brazilian Real) being the default currency in ISO 4217 format.
reference	(required, string)	The 'reference' parameter represents the Reference ID, which is a unique string generated by the merchant.
merchant_user	(required, string)	The 'merchant_user' parameter identifies the user within your system, which can be either an ID or a username
country	(required, string)	The 'country' parameter specifies the user's country configured on the merchant cashier, adhering to ISO 3166 format. Only 'BR' (Brazil) is accepted.
buyer_ip	(required, string)	The 'buyer_ip' parameter represents the user's IP address.
phone	(optional, string)	The 'phone' parameter represents the user's phone number. It should follow the suggested format: (51)9999-999, where (51) is the area code. The maximum length is 45 characters.
brand	(optional, string)	The 'brand' parameter is defined by the merchant and represents the brand of the platform.
successRedirectUrl	(required, string)	The 'successRedirectUrl' parameter specifies the URL where the user will be redirected upon successful transaction completion.
failedRedirectUrl	(required, string)	The 'failedRedirectUrl' parameter specifies the URL where the user will be redirected in case the transaction fails.

{
    "iat": 1665678422,
    "exp": 1665678482,
    "data": {
      "name": "",
      "email": "",
      "cpf": "",
      "phone": "",
      "amount": 0,
      "currency": "BRL",
      "reference": "",
      "merchant_user": "",
      "brand": "",
      "country": "BR",
      "buyer_ip": "",
      "successRedirectUrl": "",
      "failedRedirectUrl": ""
    }
}

Example Response (after JWT-decode)

{
  "iat": 1637318390,
  "exp": 1637318450,
  "code": 201,
  "data": {
    "id": "100446",
    "currency": "BRL",
    "amount": "200,00",
    "reference": "587980673109",
    "paymentInitiationUrl": "https://app.iniciador.com.br/pag-redir-error?v=vPXN9WNyDmhw9WXxVokWF250qRo",
  }
}