Payouts

Send funds from your Kashier balance to bank accounts, cards, and mobile wallets through the Payouts API. Use it to pay vendors, suppliers, employees, or customers programmatically.

Hosts

Payouts span two hosts, and both are valid:

Each endpoint below states its own host. Use the host shown for that endpoint rather than assuming one base URL for the whole domain.

Looking for account management or the balance ledger instead? See Accounts and balance — that's also where Get account info (GET /v2/account) now lives, alongside the rest of the account read/write endpoints.

List all transfers

To list all the transfers, you need to make a GET request to the list all transfers API.

limit, page, and sortType are optional pagination controls — page is 1-based and sortType is -1 for newest first or 1 for oldest first.

Headers

curl -X 'GET' 'https://test-api.kashier.io/v2/transfers?limit=5&page=1&sortType=-1'
    -H 'Authorization: your_secretKey'
    -H "accept: application/json"

Full parameter and response reference → List all transfers.

Get transfer details

To get transfer details, you need to make a GET request to the transfer details API, including the transfer ID as a parameter.

Headers

curl --location 'https://test-api.kashier.io/v2/transfers/{{transferId}}' \
--header 'Authorization: your_secretKey' \
--header 'Content-Type: application/json' \

Full parameter and response reference → Get transfer details.

Fees inquiry

To inquire about the fees, you can make a POST request to the fees inquiry API.

Headers

curl -X 'POST' 'https://test-api.kashier.io/v2/transfers/fee-inquiry' \
    -H 'Authorization: your_secretKey'
    -H "accept: application/json"
    --data '{
        "transfers": [
            {
                "amount": "100", // transfer amount that you want to inquire about its fees
                "method": "wallet" // use card, wallet, bank or instant wallet for different methods
           }
        ]
    }'

Full parameter and response reference → Fees inquiry.

Transfer methods

method is lowercased before validation, so send it in lower case.

The dedicated batch routes hang off the same transfers path as Bulk transfers and take an XLSX upload. /batch/instant-wallet and /batch/octo-payout accept the columns Recipient Name, Recipient Number, Amount, Merchant Transfer Id, and force the method for every row. A generic /batch file whose rows mix methods is stored with the batch method mixed.

Validation rules

Requests that break these rules are rejected with a 400 before any money moves.

Bank codes

recipientBank takes a bank abbreviation, not a name or a SWIFT code. It is uppercased before validation, and an abbreviation Kashier does not recognise is rejected with a 400 before any money moves.

Download the full list here:

Create transfer

To create a transfer, you need to make a POST request to the create transfer API.

Headers

The kashier-hash request header

Transfer creation can be signature-protected. When Kashier enables the transfers hashing capability on your merchant account, every create-transfer request must carry a kashier-hash header; a missing or mismatched hash is rejected with a 403. When the capability is off, the header is ignored. If you are getting a 403 on create with valid keys and no explanation, this is the first thing to check with your account manager.

The value is the HMAC-SHA256 of the string below, hex-encoded, keyed by your transfer API key — a different key from the payment API key used for order hashing:

/?transfer={merchantId}.{method}.{recipientName}.{recipientNumber}.{amount}

If you send a merchantTransferId, append it as a sixth segment, and sign that variant instead:

/?transfer={merchantId}.{method}.{recipientName}.{recipientNumber}.{amount}.{merchantTransferId}

The key must match the mode you are calling in — a test transfer API key for the test hosts, a live one for live.

curl -X 'POST' 'https://test-fep.kashier.io/v3/transfers/single'
    -H 'Authorization: your_secretKey'
    -H "accept: application/json"
    --data '{
        "amount": 10,
        "method": "wallet", // use card, wallet, bank or instant wallet for different methods
        "recipientName": "Jhon Doe",
        "merchantTransferId":"TRF-YOUR-OWN-UNIQUE-ID", // optional; must be unique per merchant
        "recipientNumber": "01555539512"
    }'

The create call returns status: "PENDING" — the transfer is accepted, not sent. It then moves through INITIATED → IN_TRANSIT → TRANSFERRED or FAILED asynchronously, and the final provider result is never in this response. Track the outcome with Get transfer details or the payouts webhook.

Full parameter and response reference → Create transfer.

Bulk transfers

To create a bulk transfer, you need to make a POST request to the create bulk transfer API.

Headers

curl -X POST 'https://test-fep.kashier.io/v3/transfers/batch?merchantBatchId=:merchantBatchId&batchName=:batchName' \
    -H 'Authorization: your_secretKey' \
    -H "accept: application/json" \
    -F 'file=@/path/to/file.xlsx'

The upload is an XLSX file sent as multipart form data under the field name file. Its columns are method, recipientName, recipientNumber, recipientBank, amount, cardToken, and merchantTransferId; the per-row method decides the rail, and a file whose rows mix methods is stored with the batch method mixed.

Full parameter and response reference → Bulk transfers.