Create Payment

Create Payment

POST {{Environment_URL}}/v1/payments/simple-pay

To create a new Payment you must provide the amount that needs to be paid, the document of the beneficary (CPF for Physical Person or CNPJ for Legal Person) that will pay the transaction, and an externalId to identify the payment. In case of retrying the trasaction due to some failure, the externalId must be the same previously sent so that we can verify if the transaction has already been paid.

If there is a divergence in the document used to create the Payment and the document of the beneficiary that paid said Payment, it WILL be refunded. We have a compliance rule that does NOT accept a transaction created for ownerDocument: 446.463.288-28 to be paid by other people.

* This compliance rule is disabled in our SandBox environment.

Please, check our "Example Request" for more information.

Every Payment may require the following fields:

Key
Description
Required?
Data type
Example value

externalId

Unique Payment identifier.

true

String

"cmpny_245193284"

amount

Value in Real (R$) cents.

true

Integer

12000

expirationTime

Time, in seconds, for PIX transaction to expire. The maximum value is 7200 seconds (2 hours).

false

Integer

7200

expirationDate

The payment's expiration date. The maximum allowed period is 90 days, calculated from the current date. OBS: To activate this functionality, please contact us.

false

String

"2022-01-01T00:00:00.000Z"

ownerDocument

Document linked to the account owner making the payment. Either CPF or CNPJ.

true

String

"59552209099"

merchant

Enter your partner's name or your company name in this field.

true

String

"Frente Corretora"

metadata

Any aditional information regarding this operation.

false

Any

{ "isRegular": true, "ranking": 152, "referralCode": "4123u-123fjd" }

accountId

Sub account Identifier

false

String

"acc_01..."

Note on Expiration Settings

  • expirationDate(priority): Must be between 24 hours and 90 days (obs: To activate this functionality, please contact us.).

  • expirationTime: Maximum period of 2 hours (7200 seconds).

  • Note: If both fields are provided, expirationDate takes precedence.

  • If neither field is provided, the default value configured in your account will be used.

Headers

Name
Value

Authorization

Bearer <token>

Request Body

Response

PreviousCreating, finding and refunding paymentsNextList Payments