Skip to main content

​
Overview

We provide a Postman collection so you can call the Yala Payout API from Postman without writing code. The collection includes the main payout endpoints and uses environment variables for your API key and base URL.

​
Get the collection

​
Set up your environment

  1. Create a Postman Environment (e.g. “Yala Sandbox”, “Yala Production”).
  2. Add variables:
    • baseUrl — https://gateway.staging.useyala.com/v1/payout-api/payouts (sandbox) or https://gateway.useyala.com/v1/payout-api/payouts (production).
    • apiKey — Your API key for that environment.
  3. Select this environment in the environment dropdown before sending requests.
Requests in the collection use {{baseUrl}} and {{apiKey}} so they work for both sandbox and production once the environment is set.

​
What’s included

The collection includes:
  • Pairs — Get supported currency/country pairs.
  • Methods — Get payout methods for a pair.
  • Wallets — List wallets.
  • Quote — Get a quote for a payout.
  • Initiate — Create a payout.
  • Get Payout — Fetch payout details.
  • Add supporting documents — Add supporting document URLs to an existing payout.

​
Tips

  • Use the Authorization tab or the collection’s pre-request script to set x-api-key from {{apiKey}}.
  • Send an optional x-request-id header (e.g. a UUID) to help support trace requests.
  • Respect rate limits when running many requests in sequence.
Keep your API key only in Postman environment variables and never commit the collection with real keys to version control.