Create a sandbox scenario

Creates test data for a merchant in the sandbox: offers, applications, active financings, refills and payments.
Every call creates the merchant identified by external_id if it does not exist yet. Every scenario except direct_payment then resets that merchant's previous test offers, applications, contracts and active financings, so each call starts clean.
The partner's country and currency come from the credentials, never from the request.

ScenarioWhat it createsitems in the response
seed_offersAvailable offers. With bypass_kyc it also leaves a confirmed identity check, so the merchant can apply without going through KYC.List of offers: id, disbursement_amount as {currencyCode, amountE5} (amount × 100,000), repayment_rate, status, expires_at (Unix milliseconds)
pending_applicationOne offer and an application waiting for review. Needs disbursement_amount.application_id
financing_activeOne offer, an application and an active financing. Needs disbursement_amount.financing_id, application_id, features
loan_activeDeprecated alias of financing_active.Same as financing_active
refillA parent financing paid at 60% and a refill offer on top of it; an RBF_TERM parent gets a 40-day history instead, with its first period paid and the second at 80%. Needs disbursement_amount.financing_id (parent), application_id, features
direct_paymentA direct payment on the active sandbox financing given in financing_id; it is not checked against external_id. Needs financing_id and amount.List of payment results (collection_id, success, message, data)

financing_active, loan_active and refill finish part of their work in the background: the response arrives first, and the financing, the payment and the refill offer settle a few seconds later. A 200 does not guarantee that background work succeeded, so read the financing back before relying on it.

The amount disbursed in the response can differ from disbursement_amount for products that add or subtract fees: MCA_FLEX, BR and CO RBF_TERM.

Product per country, used when metadata.product_category is omitted:

CountryDefaultAlso accepted
BRRBF_DAILY_AMORTIZATION—
CLMCA_FLEXRBF_FLEX
CORBF_TERMRBF_DAILY_AMORTIZATION
MXRBF_FLEX—
PERBF_TERMRBF_DAILY_AMORTIZATION
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Scenario to create, the test merchant and its options

string
required

ExternalId is the partner's id for the test merchant. Reusing it resets that merchant's test data.

metadata
object

Metadata holds the scenario options. Each option says which scenarios use it.

string
enum
required

Scenario is the scenario to create. See the table in the endpoint description.

Allowed:
Responses

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