Making a payment
Payment requests in Waza are regarded to as Orders. Payment involves you as a business paying your partners, suppliers or customers in their preferred currency using your local fiat currency provided both currency pairs are supported.
To make a payment using Waza's B2B global payment APIs you need to:
Payment Request Parameters
Below are the parameters required to initiate a payment using our B2B global payment APIs
Param | Required? | Description |
---|---|---|
beneficiary_id | Yes | The reference of the beneficiary that was returned by us when you created one. |
amount | Yes | Amount (in the lowest currency value - kobo, cent, etc) you intend sending to the beneficiary. |
currency | Yes | The currency the order is made in. |
description | Yes | The order description. |
client_reference | No | Your unique client reference. |
metadata | No | Object containing any extra information you want recorded with the transaction. |
quote_id | Yes | The ID gotten from generating a quote. |
Example Request
A POST request should be made to our /orders endpoint
curl --location 'https://api.sandbox.waza.co/v2/orders' \
--header 'WAZA-X-KEY: {{API_KEY}}' \
--data '{
"beneficiary_id" : "clh9bsjzt0046c0vo6hpw5v1n",
"amount": 100000,
"currency": "NGN",
"description": "Test API Transfer",
"client_reference": "exists",
"metadata": {"extra": "test payment"},
"quote_id": "723cb15e-9f52-450a-9407-d6fd9299a14d"
}
'
Example Response
A successful Order API call should return a similar response structure as seen below:
{
"data": {
"id": "16d91a42-8b39-4485-a84b-58bc461232e2",
"client_reference": "exists",
"amount": 100000,
"currency": "NGN",
"receive_amount": 174,
"receive_currency": "USD",
"beneficiary_id": "clh9bsjzt0046c0vo6hpw5v1n",
"state": "pending",
"metadata": {
"extra": "test payment"
},
"fee_amount": 0,
"fee_currency": "NGN",
"rate": 0.00174044732325749,
"description": "Test API Transfer",
"destination": {
"type": "business",
"address": "Some address",
"business_name": "My good business",
"first_name": null,
"last_name": null,
"bank_name": "Test Bank",
"bank_code": "044",
"account_number": "11111434"
},
"timelines": {
"payout_sent_date": null,
"arrival_date": null
}
}
}
Updated about 1 year ago