Pular para o conteúdo principal
POST

Guia: Testes no sandbox

O que você pode simular, os caminhos a testar e o checklist antes de ir para produção.

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
resourceType
enum<string>
obrigatório

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

Opções disponíveis:
SENDER,
BENEFICIARY,
PIX_KEY,
QUOTE,
REMITTANCE,
SETTLEMENT,
INVENTORY_OBLIGATION
resourceId
string
obrigatório

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

Exemplo:

"rem_123"

status
string
obrigatório

Target status, from the status enum of the resource.

Exemplo:

"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.

Opções disponíveis:
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

Resposta

Status changed.

resourceType
string
obrigatório

Same as in the request.

resourceId
string
obrigatório

Same as in the request.

previousStatus
string
obrigatório

Status before the simulation.

status
string
obrigatório

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>
obrigatório
rejectedCode
enum<string> | null

Filled when the result is REJECTED.

Opções disponíveis:
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.