Simulate merchant advancement

Create or simulate a merchant advancement request. To trigger a simulated advancement request, you must include confirmAdvancement=false in the query. If you specify true, the advancement request becomes an actual request, not a simulation.

The endpoint enables a merchant to simulate an advancement scenario in order to validate whether or not there is enough balance in the account, as well as how much tax is anticipated. Since a simulated advancement is not a real advancement, it is not processed.

A merchant advancement is sometimes called a prepayment of receivables. You arrange to have a financial institution make regular deposits into your account equal to what you expect to receive in the future from credit card sales in installments or post-dated checks and bills. The financial institution deducts its fee before it puts the money in your account. You pay back each deposit when you receive payment from your customers. This is a way of covering business expenses in the short term. It's a cheaper alternative to a loan.

Note:

  • If the merchant is the head merchant (also called a centralizer), the advanced amount is given to the head merchant instead of individual branch merchants, this is designed for better manageability.
  • If the commercial establishment is not registered as a headquarter or a branch in the current marketplace, the advancement is for a single commercial establishment.
  • The merchant must have sufficient balance in the account for the specified date range of the advancement.

This endpoint generates a Merchant advancement request created event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uint64
required
1 to 18446744073709552000

Marketplace ID

uint64
required
1 to 18446744073709552000

Merchant ID

Query Params
boolean
Defaults to false

Flag that indicates whether this is an effective advancement or just a simulation. The default value is false.

Body Params
date
required
length between 10 and 10

Used for searching merchant advancement requests. This is the start date of your search range.

date
required
length between 10 and 10

Date for payment of the advancement

float
required
1 to 4294967295

Net amount to be paid in advance

string

Represents the currency with an ISO-4217 alphabetic or numeric (3 characters) string. For example, you represent Brazilian real with either BRL or 986. If you don't provide this code, the system uses the currency from the merchant program.

boolean
required
Defaults to false

If true, the transaction is settled real-time; that is, at the exact moment. Default is false

date
length between 10 and 10

Used for searching merchant advancement requests. This is the end date of your search range

float
1 to 4294967295

Campaign advancement fee to be applied to the current advancement request. It replaces the advancement fee set for the merchant in the request

float
1 to 4294967295

Campaign discount rate to be applied to all merchants in the current advancement request

merchants
array of objects
merchants
Headers
string
required

Authorization token

Responses

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