payments

ID of the payment order
minLength: 1
maxLength: 100
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$
example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl

Applications ID created by merchants
minLength: 1
maxLength: 100
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$
example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl

appId

merchant's internal orderId. Only can be used for once. 

clientRequestId

institutionId

User (natural person) who is logged in to the payment initiator institution

customer

Payment initiation date, the date here must be utc-3
maxLength: 10
pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
example: 2021-01-01

date

Unique identifier of the consent created for the initiation of the requested payment
maxLength: 256
pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$
example: urn:bancoex:C1DD33123

consentId

It is a unique identifier, generated in the initiating payment institution and received in the account holding institution, permeating the entire payment journey Pix.
minLength: 32
maxLength: 32
pattern: ^([E])([0-9]{8})([0-9]{4})(0[1-9]|1[0-2])(0[1-9]|[1-2][0-9]|3[0-1])(2[0-3]|[01][0-9])([0-5][0-9])([a-zA-Z0-9]{11})$
example: E9040088820210128000800123873170

endToEndId

pattern: ^[a-zA-Z0-9]{1,35}$
maxLength: 35
example: E00038166201907261559y6j6

transactionIdentification

User (natural person) who is logged in to the Payment Initiator institution.
maxLength: 11
example: 11111111111
pattern: ^\d{11}$
[Restriction] Required if customer.identifierType is CNPJ

loggedUserCpf

ibge town code
minLength: 7
maxLength: 7
pattern: ^\d{7}$
example: 5300108

ibgeTownCode

Pix key
maxLength: 77
pattern: [\w\W\s]*
example: 12345678901
The types of keys can be: phone, e-mail, CPF/CNPJ or random key.
In the case of a mobile phone, it must be informed in the E.1641 standard. 
In the case of e-mail, it must have the format xxxxxxxx@xxxxxxx.xxx(.xx) and a maximum of 77 characters. 
In the case of CPF, it must be informed with 11 numbers, without dots or dashes. In the case of CNPJ, it must be informed with 14 numbers, without dots or dashes. 
[Restriction] If initType is PIX_MANU, the proxy field should not be filled in. If initType is PIX_INIC, PIX_DICT, PIX_QRCODE, the proxy field should always be filled with the Pix key.

proxy

QR code
maxLength: 512
pattern: [\w\W\s]*
example: 00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012 BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062 530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76
This field should be in UTF-8 format.  
[Restriction] Required for PIX_QRCODE payments, with a maximum size of 512 bytes.

qrCode

Payment initiation type
PIX_INIC - Pre registration of payee's account
PIX_MANU - The creditor object must be sent with all payee information.
PIX_DICT - The pixKey field represents creditor information.
PIX_QRCODE - The qrCode field represents creditor information.

initType

Amount that will be paid by the user
minLength: 4
maxLength: 19
pattern: ^((\d{1,16}\.\d{2}))$
example: 100000.12
[Restriction] The value with 2 decimal places. 

amount

maxLength: 3
pattern: ^([A-Z]{3})$
example: BRL
National currency code according to ISO-4217, i.e., 'BRL'. All reported monetary values are represented with the current currency of Brazil.

currency

Payment description
maxLength: 140
pattern: [\w\W\s]*
example: Pagamento da nota XPTO035-002.
It must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient.

remittanceInformation

debtorAccount

creditorAccount

externalInfo

cancellation

status

statusReason

Create time - utc time format
pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$
example: 2020-07-21T08:30:00Z

createAt

Status update time - utc time format
pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$
example: 2020-07-21T08:30:00Z

statusUpdateAt

AuthorisationFlow

Learn how to make a GET request to a specific endpoint using a curl command example provided in this document. Discover the necessary headers, authorization token, request method, header, and path parameters explained in detail. Gain insights into the res

Create a payment initiation with whitelabel

Get a payment initiation

Await for payment status

Klavi Payment Docs

Overview

Getting Started

Intergration whit whitelabel

Intergration with instant API

Intergration with Automatic Pix API

How To Integrate

Authentication

Participant Institutions

Postman Collection

Environment

Return Codes

Event Name

Event Examples

Payment Events2

Instant Payment

Automatic Pix

JSR-Enrollment status

Untitled

Time Zone And Date

Rate Limits And Throughput

Time Limits

Security

Generate access token

/auth

Get a list of institutions

Create a payment initiation

Cancel a payment initiation

Instant payment

Create a consent

Create a consent-links

Get the consent resource

Get the consent status

Revoke the consent

Create a payment

Get the payment resource

Create a retry payment

Get the payment status

Cancel the payment

API Reference-Customer

Get a merchant information

Get the application list of merchants

Register or update a receiving account for the  application

Get accounts for the application

/merchant

Get all payment initiation orders

Get a payment initiation order

Get consent list

Get all orders from an consent

Release History