/consents

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.

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

clientMetadata

Authorization

status

statusReason

 Only status = CONSENT_AWAITING_AUTHORIZATION then will a valid URL be generated.

consentRedirectUrl

Cancel a payment initiation

Create a consent

Create a consent-links

Klavi Payment Docs

OVERVIEW

Getting started

Concepts

Whitelabel Initiation

API Only Initiation

How to integrate

Authentication

Participant Institutions

Postman Collection

Environment

Return Codes

Payment Events

Payment Status

Formatting and time zone conventions of times date and time fields

Rate Limits and Throughput

Time Limits

Security

Untitled

Overview

/auth

Payments

Customer

/merchant

Integration with page

API REFERENCE

Release History