/consent/{id}

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

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

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

loggedUserCpf

Return rediect url after user checkout in Klavi env

redirectURL

Must be filled in whenever the paying user enters some additional information in the consent
example: Minha recorrência
pattern: [\w\W\s]*
maxLength: 140

additionalInformation

debtorAccount

Object containing the data of the recipient (creditor)

creditorAccount

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

paymentMethod

paymentMethodConfig

externalInfo

The date and time when the consent shall cease to be valid. A string with date and time as specified in RFC-3339, always using the UTC time format.
example: 2021-05-21T08:30:00Z
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$
maxLength: 20

expirationDateTime

example: CONSENT_AWAITING_AUTHORIZATION
Current status of recurring consent according to the state machine
Enum:
  [ STARTED,EXPIRED,CONSENT_AWAITING_AUTHORIZATION, CONSENT_AUTHORIZED, CONSENT_REJECTED, CONSENT_PARTIALLY_ACCEPTED, CONSENT_REVOKED, CONSENT_PERIOD_EXPIRED, CANCELED, ERROR ]

status

statusReason

example: 2021-05-21T08:30:00Z
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$
maxLength: 20
Create time

createAt

example: 2021-05-21T08:30:00Z
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$
maxLength: 20
Status update time

statusUpdateAt

Create a consent-links

Get the consent resource

Get the consent 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

Create a payment initiation with whitelabel

Get a payment initiation

Await for payment status

Cancel a payment initiation

Create a consent

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