Environments

Learn more about the different environments available.

Sandbox

The sandbox environment allows you to test your integration with the Payouts API. It simulates API requests and transaction types, so you can validate your implementation before going live.

Sandbox base URL

URL Selector with Opacity

Sandbox transactions are simulated and not actually processed.


Simulate payout statuses in sandbox

In Sandbox, you can control the payout result by passing a status code in the request body's description field.

  • Input. Set the desired mock scenario using the description field in your payout request.
  • Output. The mock server responds with the mapped status, status_code, and status_detail.

Example

  • Successful payout. If you provide description: DELIVERED:PAID in the request, you'll subsequently receive a notification with status: PAID, status_code: 200, and status_detail: The payout was paid.
  • Fail payout. If you provide description: DELIVERED:5011, you'll subsequently receive a notification with status: BAD_REQUEST, status_code: 5011, and status_detail: External ID already used.
{
  "external_id": "your_external_id",
  "payment_method_id": "INSTANT_PAYMENT",
  "flow_type": "B2C",
  "country": "BR",
  "currency": "BRL",
  "purpose": "DIGITAL_GOODS",
  "amount": 129.19,
  "notification_url": "https://yoururl.com/notification",
  "beneficiary": {
    "first_name": "John",
    "last_name": "Doe",
    "document": {
      "id": "39446691001"
    },
    "instant_payment": {
      "id": "39446691001"
    }
  },
  "description": "DELIVERED:3001"
}

Sample description values to simulate card responses

description (input)Simulated status (output)status_code (output)status_detail (output)
DELIVERED:3000BAD_REQUEST3000Invalid params
DELIVERED:3001BAD_REQUEST3001Empty params
DELIVERED:3003BAD_REQUEST3003Invalid bank code
DELIVERED:4001FORBIDDEN4001Invalid credentials
DELIVERED:4002FORBIDDEN4002Unregistered IP address (register in Dashboard)
DELIVERED:5007BAD_REQUEST5007Country not found for payouts
DELIVERED:5008BAD_REQUEST5008Limit exceeded
DELIVERED:5009BAD_REQUEST5009Payout not found with this ID
DELIVERED:5010BAD_REQUEST5010Invalid status: payout is not pending
DELIVERED:5011BAD_REQUEST5011External ID already used
DELIVERED:5012BAD_REQUEST5012Rejected compliance limits
DELIVERED:5013BAD_REQUEST5013End beneficiary blacklisted
DELIVERED:5014BAD_REQUEST5014Insufficient funds
DELIVERED:5015BAD_REQUEST5015Rejected due to compliance
DELIVERED:7002BAD_REQUEST7002Could not cancel the payout
DELIVERED:7004BAD_REQUEST7004Could not release the payout due to compliance
DELIVERED:ON_HOLDON_HOLD600The payout is on hold by the merchant
DELIVERED:ON_HOLD_BY_COMPLIANCEON_HOLD_BY_COMPLIANCE700The payout is pending from compliance checks
DELIVERED:PAIDPAID200The payout was paid

Production

After successful testing, you can switch to the production environment.

Production base URL

URL Box