orders

appId

Your internal orderId. Only can be used for once. 
you can use it to associate a payment and you can use UUID generation algorithm to generate it

clientRequestId

institutionId

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

customer

maxLength: 10
pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$
example: 2021-01-01
Date of payment creation

date

pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$
maxLength: 256
Consent Id

consentId

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: E9040088820241225150000123873170
It should be filled in the default format ExxxxxxxxyyyyMMddHHmmkkkkkkkkk (32 characters; "case sensitive", i.e., case sensitive)

endToEndId

pattern: ^[a-zA-Z0-9]{1,35}$
maxLength: 35
example: E00038166201907261559y6j6
This is a transaction identifier that must be transmitted intact by the payer’s PSP when generating the payment order. This information will allow the recipient to identify and correlate the transfer, when received, with the presentation of the instructions to the payer. The characters allowed in the Pix context for the txid field (EMV 62-05) are: Low case letters, from 'a' to 'z' Upper case letters, from 'A' to 'z' Decimal digits, from '0' to '9'.

transactionIdentification

User (natural person) who is logged in to the Payment Initiator institution.
required if customer.identifierType = CNPJ

loggedUserCPF

minLength: 7
maxLength: 7
pattern: ^\d{7}$
example: 5300108
The ibgeTownCode field in the Pix array has the same behavior as the codMun field described in item 1.6.6 of the Pix manual. If the municipality information is not sent, the recipient's PSP will assume that there are no state and municipal holidays in the period in question;

ibgeTownCode

pattern: [\w\W\s]*
example: 11221131242
if initType = PIX_DICT or PIX_INIC
Key registered in the DICT belonging to the recipient. The types of keys can be: phone, e-mail, cpf/cnpj or random key. In the case of mobile phone should be reported in the E.1641 standard. Email must have the format xxxxxxxx@xxxxxxx.xxx  (.xx) and maximum 77 characters. In the case of CPF, it should be indicated with 11 numbers, without dots or dashes. In the case of CNPJ, it must be reported with 14 numbers, without dots or dashes. In the case of a random key, the UUID generated by DICT must be reported, as specified in RFC4122.

proxy

qrCode

example: PIX_INIC
Enum: [ PIX_INIC, PIX_MANU,PIX_DICT，PIX_QRCODE ]

initType

minLength: 4
maxLength: 19
pattern: ^((\d{1,16}\.\d{2}))$
example: 100000.12
Transaction 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

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

Object containing the data of the recipient (creditor).

creditorAccount

externalInfo

Object containing the data relating to the paying user who requested the cancellation, the channel used by him and the reason.

cancellation

example: PAYMENT_PENDING
Enum:
[PAYMENT_PENDING,PAYMENT_READY_FOR_SETTLEMENT,PAYMENT_SCHEDULED,PAYMENT_SETTLEMENT_PROCESSING, PAYMENT_COMPLETED,PAYMENT_REJECTED]

status

statusReason

maxLength: 20
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

statusUpdateAt

paymentMethod

Field intended for the configuration of the different recurring payment products.

paymentMethodConfig

retries

Get all payment initiation orders

Get a payment initiation order

Get consent list

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

Create a payment initiation with whitelabel

Get a payment initiation

Await for payment status

Cancel a payment initiation

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

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

Payment Orders

Get all orders from an consent

API Reference-Management

Release History