Initiate Payout

Initiate a payout using the current USD→NGN rate.

POST /api/v1/payout?pair=usd_ngn

curl -X POST "https://api.yara.cash/api/v1/payout?pair=usd_ngn" \
  -H "Content-Type: application/json" \
  -H "x-yara-api-key: <secret-key>" \
  -d '{
    "email": "[email protected]",
    "reference": "reference-1",
    "amount": 20,
    "bankCode": "100004",
    "bankAccountNumber": "8001234567",
    "paymentRemarks": "test payouts",
    "fromCurrency": "USDT",
    "payoutcurrency": "NGN"
}'

Response

{
    "data": {
        "fiatAmount": 0,
        "id": "076121d4-2cac-42e8-8027-02a24b5b49e2",
        "status": "initiated"
    },
    "status": "success"
}

Payouts History

Returns Payouts History with pagination.

GET /api/v1/payout/history?page=<page>&limit=<limit>

curl -X GET https://api.yara.cash/api/v1/payout/history?page=<page>&limit=<limit> \
    -H "x-yara-api-key: <secret-key>" \
    -H "Content-Type: application/json"

Response

{
    "data": {
        "pagination": {
            "limit": <limit>,
            "page": <page>,
            "total": <total>
        },
        "payouts": [
            {
                "id": <id>,
                "accountId": <accountId>,
                "type": <type>,
                "status": <status>,
                "amount": <amount>,
                "currency": <currency>,
                "counterpartyName": <counterpartyName>,
                "createdAt": <createdAt>,
                "payoutIntentId": <payoutIntentId>,
                "payoutType": <payoutType>,
                "exchangeRate": <exchangeRate>,
                "fees": <fees>,
                "fiatAmount": <fiatAmount>,
                "fiatCurrency": <fiatCurrency>
            }
        ]
    },
    "message": "success"
}

Get Payout by Reference

Returns Payout by Reference.

GET /api/v1/payout?reference=<reference>&id=<id>

curl -X GET https://api.yara.cash/api/v1/payout?reference=<reference>&id=<id> \
    -H "x-yara-api-key: <secret-key>" \
    -H "Content-Type: application/json"

Response

{
    "data": {
        "amount": 2,
        "amountUSD": 2,
        "btcAddress": "",
        "ethAddress": "",
        "fiatPayoutAmount": 2902.1627399999998,
        "id": "4c850223-5fed-4c1e-82d2-b3a340071349",
        "payoutCurrency": "NGN",
        "payoutType": "PAY_FROM_BALANCE",
        "reference": "reference-6",
        "solAddress": "",
        "source": "API",
        "sourceCurrency": "USDT",
        "status": "PAYOUT_SUCCESS",
        "tronAddress": ""
    },
    "message": "success"
}