Migrate accruals

Start accruals migration.

This endpoint generates the following events:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Start an accruals migration

migration
object
required

Client-provided migration details

date

Accounting date for the migration, which you must set to the go-live date. Format = YYYY-MM-DD.

metadata
object

Accruals metadata (free-form fields) formatted as a JSON object using any key-value pairs.

string
enum

Accrual type

Note: Do not use DECENDIAL_IOF or WITHDRAW_IOF as these are outdated.

  • REFINANCING—Interest accrual amounts where the cardholder pays less than the minumum invoice amount
  • NOTACCRUABLE_NOTFINEABLE—Amounts that are not subject to accruals or fines
Allowed:
string
enum
deprecated

Authorization type of the transaction. Note: Required when accrual type is DECENDIAL_IOF, however DECENDIAL_IOF is outdated and should not be used.

Allowed:
projected_values
array of objects

List of projected accrual values, for an account between cycle closing and due date. (For pending accruals, use a values array.) These values will be split between the dates ranging from cycle closing date (exclusive) up to the due date. For projected REFINANCING accruals, the interest is on revolving charges. These charges might be reversed if the account receives an advance payment. If the projection occurs on the cutoff date, the projected balance is calculated to match the actual amount between the cutoff and the invoice due date.

projected_values
values
array of objects

List of accrual values for pending accruals. (For projected accruals, use a projected_values array.) For pending REFINANCING accruals, the original processor calculated the value for revolving overdue charges. The pending amount refers to a daily amount for the period from the day after the due date in the prior month (M-1) up to the go-live date (known in Brazil as "saldo rotativo"). Pass the value when the account holder paid less than the Total Amount Due (TAD).

values
Responses
202

Accepted

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json