API Reference

Check

Responsible for returning the installment options to the customer. We suggest using it when the customer clicks on “Select Installments”.

❗️

ATTENTION

Whenever there is a change in the information consulted (CPF, E-mail, Total Value or Date of Use of the Service), a new request must be carried out to verify the availability and installment options according to the new information.

📘

For every include request sent, a new check is mandatory.

Field

Type

Description

Required

CPF

String (14)

Payer's CPF

Yes

Email

String (300)

Payer's Email

Yes

TotalPrice

String (9.2)

Total value of the purchase - Ex.: 250.99 (Use dot to separate decimal place)

Yes

UseDate

String (10)

Product delivery forecast / Service usage date / Course completion date Format: yyyy-MM-dd

Yes

SalesChannelId

String (2)

Sales Channel Code, where: 3 = Checkout; 31 = Mobile Checkout; 5 = Checkout Recovery.

Yes

Proposal

String (20)

In-store order identifier.

Yes

Language
Credentials
Header
Click Try It! to start a request and see the response here!