Skip to main content
POST

Guide: Testing in the sandbox

What you can simulate, the paths to test and the checklist before going live.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
resourceType
enum<string>
required

Type of the record. PIX_KEY is a payment instruction of a beneficiary. INVENTORY_OBLIGATION is the USDC obligation of an Inventory Lot.

Available options:
SENDER,
BENEFICIARY,
PIX_KEY,
QUOTE,
REMITTANCE,
SETTLEMENT,
INVENTORY_OBLIGATION
resourceId
string
required

ID of the record: senderId, beneficiaryId, paymentInstructionId (for PIX_KEY), quoteId, remittanceId, settlementId or inventoryId (for INVENTORY_OBLIGATION).

Example:

"rem_123"

status
string
required

Target status, from the status enum of the resource.

Example:

"PROCESSING"

rejectedCode
enum<string>

Required when resourceType = REMITTANCE and status = REJECTED; not accepted otherwise. rejectedDescription is filled by the system with the standard text of the code.

Available options:
QUOTE_EXPIRED,
QUOTE_ALREADY_USED,
QUOTE_USAGE_MISMATCH,
SENDER_NOT_ELIGIBLE,
BENEFICIARY_NOT_ELIGIBLE,
RELATIONSHIP_MISMATCH,
PAYMENT_INSTRUCTION_INVALID,
PIX_KEY_NOT_FOUND,
FUNDING_MODE_NOT_ENABLED,
CREDIT_LIMIT_EXCEEDED,
INSUFFICIENT_PREFUNDED_BALANCE,
AMOUNT_BELOW_MINIMUM,
AMOUNT_ABOVE_LIMIT,
ACCOUNT_DAILY_LIMIT_EXCEEDED,
INVENTORY_NOT_FOUND,
INVENTORY_SUSPENDED,
INSUFFICIENT_INVENTORY_BALANCE,
COMPLIANCE_REJECTED

Response

Status changed.

resourceType
string
required

Same as in the request.

resourceId
string
required

Same as in the request.

previousStatus
string
required

Status before the simulation.

status
string
required

Resulting status. It differs from the requested one in one case: REMITTANCE → PROCESSING runs the real validation and can result in REJECTED.

simulatedAt
string<date-time>
required
rejectedCode
enum<string> | null

Filled when the result is REJECTED.

Available options:
QUOTE_EXPIRED,
QUOTE_ALREADY_USED,
QUOTE_USAGE_MISMATCH,
SENDER_NOT_ELIGIBLE,
BENEFICIARY_NOT_ELIGIBLE,
RELATIONSHIP_MISMATCH,
PAYMENT_INSTRUCTION_INVALID,
PIX_KEY_NOT_FOUND,
FUNDING_MODE_NOT_ENABLED,
CREDIT_LIMIT_EXCEEDED,
INSUFFICIENT_PREFUNDED_BALANCE,
AMOUNT_BELOW_MINIMUM,
AMOUNT_ABOVE_LIMIT,
ACCOUNT_DAILY_LIMIT_EXCEEDED,
INVENTORY_NOT_FOUND,
INVENTORY_SUSPENDED,
INSUFFICIENT_INVENTORY_BALANCE,
COMPLIANCE_REJECTED
rejectedDescription
string | null

Filled when the result is REJECTED.