Payment Operations

Simple operation you can perform to manage payments with Lync

The Payment Operations API provides endpoints for retrieving and managing payments. These endpoints allow institutions to:

List all payments – Retrieve a paginated list of payments.
Get payment details – Fetch detailed information about a specific payment.
Download payment receipt – Obtain a PDF receipt of a completed payment.

🚧
Notes

All amounts are represented in the smallest unit of their respective currency (e.g., cents for USD, Kobo for NGN)

For exchange payments, the fx_rate object contains the applied exchange rate details

The balance_before and balance_after fields show the impact on the source account

FX exchange payments may include an fx_settlement_id referencing the settlement batch

1. List Payments

This endpoint retrieves a paginated list of payments associated with an institution. The response includes details such as amount, status, billing amount, destination amount, and payment type.

Query Parameters (Optional)

Parameter	Type	Required	Description
`counterparty_ids[]`	string[]	❌ No	Filter payments by counterparty IDs.
`states[]`	string[]	❌ No	Filter payments by state (`COMPLETED`, `PROCESSING`, etc.).
`completion_date_from`	string	❌ No	Filter by start date of completed payments (`YYYY-MM-DD`).
`completion_date_to`	string	❌ No	Filter by end date of completed payments (`YYYY-MM-DD`).
`created_date_from`	string	❌ No	Filter by start date of created payments (`YYYY-MM-DD`).
`type[]`	string[]	❌ No	Filter payments by type (`DEPOSIT`, `TRANSFER`, `EXCHANGE`).
`keyword`	string	❌ No	Search payments using a keyword (e.g., reference ID).
`account_ids`	string[]	❌ No	Filter payments by account IDs.

Example Request

GET http://api.sandbox.waza.co/lync/banking/v2/payments?states[]=COMPLETED&type[]=DEPOSIT

Example Response

{
    "data": {
        "items": [
            {
                "id": "0195575a-1ffa-7808-a6f6-612e772d1706",
                "state": "PROCESSING",
                "created_date": "2025-03-02T14:54:39.098Z",
                "updated_date": "2025-03-02T15:00:00.561Z",
                "source_amount": 10000,
                "source_currency": "EUR",
                "sending_amount": 10000,
                "billing_amount": 10000,
                "total_fee_amount": 0,
                "destination_amount": 10702,
                "destination_currency": "USD",
                "description": "Currency exchange from EUR to USD",
                "direction": "OUTBOUND",
                "type": "EXCHANGE"
            }
        ],
        "page": 1,
        "limit": 10,
        "total_items": 2,
        "total_pages": 1
    }
}

2. Get Payment Details

This endpoint retrieves detailed information about a specific payment, including the status, amount, exchange rate, fees, and metadata.

Path Parameter

Parameter	Type	Required	Description
`id`	string	✅ Yes	The unique identifier of the payment.

Example Request

GET http://api.sandbox.waza.co/lync/banking/v2/payments/01953d10-c64b-7532-8f7e-6b90badcf3f5

Example Response

{
  "data": {
    "id": "01953d10-c64b-7532-8f7e-6b90badcf3f5",
    "state": "COMPLETED",
    "created_date": "2025-02-25T12:24:24.395Z",
    "updated_date": "2025-02-25T12:45:10.501Z",
    "source_amount": 609,
    "source_currency": "EUR",
    "sending_amount": 600,
    "billing_amount": 609,
    "total_fee_amount": 9,
    "destination_amount": 507,
    "destination_currency": "GBP",
    "reference": "wz-payout-EEEa-1740486264395",
    "completion_date": "2025-02-25T00:00:00.000Z",
    "description": "Operational Expenses – Rent, utilities, and other business running costs.",
    "direction": "OUTBOUND",
    "type": "TRANSFER",
    "fx_rate": {
      "pair": "EUR/GBP",
      "sell": 1.1846,
      "buy": 1.1846,
      "description": "1.1846 EUR => 1 GBP"
    }
  }
}

Response Fields

Field	Type	Description
`id`	string	The unique identifier of the payment.
`state`	string	The status of the payment (`PROCESSING`, `COMPLETED`).
`created_date`	string	The date the payment was created (`YYYY-MM-DD`).
`updated_date`	string	The last updated date of the payment.
`source_amount`	number	The amount sent from the source account.
`source_currency`	string	The currency of the source amount.
`sending_amount`	number	The amount actually sent (after fees).
`billing_amount`	number	The total amount charged, including fees.
`total_fee_amount`	number	The total fees applied to the payment.
`destination_amount`	number	The final amount received by the counterparty.
`destination_currency`	string	The currency of the received amount.
`reference`	string	The payment reference ID.
`completion_date`	string	The date the payment was completed.
`description`	string	A description of the payment purpose.
`direction`	string	Payment direction (`INBOUND`, `OUTBOUND`).
`type`	string	Payment type (`TRANSFER`, `DEPOSIT`, `EXCHANGE`).
`fx_rate.pair`	string	The currency pair for the exchange.
`fx_rate.sell`	number	The sell rate used for conversion.
`fx_rate.buy`	number	The buy rate used for conversion.

3. Download Payment Receipt

This endpoint retrieves a PDF receipt of a completed payment.

Path Parameter

Parameter	Type	Required	Description
`paymentId`	string	✅ Yes	The unique identifier of the payment.

Example Request

GET http://api.sandbox.waza.co/lync/banking/v2/payments/0191ae00-b9ed-780d-b6d2-6619cadf8f9d/receipt

Response

The response will contain the payment receipt as a PDF file.
The Content-Type in the response headers will be application/pdf.
Ensure your system correctly handles file downloads based on the response format.

Updated 2 months ago