List Swaps - Yala Payout APIs

Overview

Returns swaps for the authenticated business (method is always SWAP). Payouts are not included — use List Payouts. To load one swap, use Get Swap by ID. A new swap is PROCESSING until ops marks it SUCCESSFUL or REJECTED.

Request

GET /v1/payout-api/payouts/swaps?page=1&limit=20 HTTP/1.1
Host: gateway.staging.useyala.com
x-api-key: <YOUR_API_KEY>

Query parameters

Parameter	Required	Description
`page`	No	Page number, starting at 1. Default `1`.
`limit`	No	Page size. Default `20`. Maximum `100`.

Response

{
  "data": [
    {
      "id": "223e4567-e89b-12d3-a456-426614174001",
      "payoutRef": "PAY-2024-002",
      "status": "PROCESSING",
      "method": "SWAP",
      "sourceAmount": 1000,
      "sourceCurrency": "USD",
      "destinationAmount": 1500000,
      "destinationCurrency": "NGN",
      "exchangeRate": 1500,
      "transactionFees": 0,
      "createdAt": "2024-01-21T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "size": 1
  }
}

Usage Example

async function listSwaps() {
  const url = new URL('https://gateway.staging.useyala.com/v1/payout-api/payouts/swaps');
  const response = await fetch(url, { headers: { 'x-api-key': apiKey } });
  return response.json();
}

const { data } = await listSwaps();