Postman Collection

​

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

• Collection URL: https://docs.useyala.com/resources/postman.json
• Import: In Postman, use Import and paste the collection URL above (or download the JSON and import the file).

​

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. Collection variables uploadUrl, documentUrl, and payoutId are filled automatically when you run the upload-url and initiate requests (see below).

​

What’s included

The collection includes:

• Pairs — Get supported currency/country pairs.
• Methods — Get payout methods for a corridor.
• Wallets — List wallets.
• Quote — Get a quote for a payout.
• Supporting documents (folder):
  • Get Document Upload URL — Presigned upload metadata (saves uploadUrl and documentUrl).
  • Upload File to S3 — PUT file bytes to uploadUrl (not to Yala).
  • Add Supporting Documents — Attach documentUrl to an existing payout.
• Initiate — Create a payout (uses {{documentUrl}} when provided).
• Initiate Swap — Move funds between two wallets (sourceWalletId and destinationWalletId from Get wallet balances).
• List Payouts — payouts only (excludes swaps).
• List Swaps — swaps only.
• Get Payout by ID / Get Swap by ID — separate get routes.
• Get Payout — Fetch payout details.

​

Testing supporting documents in Postman

Most payouts need an invoice. Withdrawals to your business or a UBO account do not.

1. Get Document Upload URL
2. Upload File to S3 (see the request description in the collection)
3. Initiate Payout or Add Supporting Documents with {{documentUrl}}

See Uploading Supporting Documents.

​

Initiate sample body (SWIFT USA)

The collection Initiate Payout example uses the same corridor as Get quote and Get Payment methods and rates (NGN to USD, USA, SWIFT). Required beneficiary fields for SWIFT include swiftCode, bankName, and beneficiaryCountry. Fields like routingNumber and accountType apply to ACH, not SWIFT. Before changing the initiate body for another method, call GET /methods for your corridor and copy requiredFields into beneficiary.

​

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.