Skip to main content
GET
/
api
/
v1
/
merchants
/
{merchantID}
/
operations
curl -X GET "https://api.yourdomain.com/api/v1/merchants/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/operations?limit=10&offset=0" \
  -H "Authorization: Bearer uwk_YOUR_API_KEY_HERE"
[
  {
    "operationID": "op_8b7c9d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "cash-in",
    "amount": "50000.00",
    "fee": "0",
    "distributorTo": "36e48800-22ce-4ea0-b37a-198f7978cd53",
    "distributorName": "PAPSS Distributor",
    "memo": "Monthly deposit",
    "blockchainID": "tx_abc123...",
    "createdAt": "2026-02-12T10:30:00Z",
    "updatedAt": "2026-02-12T10:30:15Z"
  },
  {
    "operationID": "op_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "pay-individual",
    "amount": "3000.00",
    "fee": "50.00",
    "phoneTo": "+234 8123456781",
    "memo": "Refund for order #1234",
    "blockchainID": "tx_def456...",
    "createdAt": "2026-02-12T09:15:00Z",
    "updatedAt": "2026-02-12T09:15:20Z"
  },
  {
    "operationID": "op_2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "pay-merchant",
    "amount": "15000.00",
    "fee": "100.00",
    "merchantTo": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
    "merchantName": "Supplier Co.",
    "memo": "Wholesale payment",
    "blockchainID": "tx_ghi789...",
    "createdAt": "2026-02-11T14:00:00Z",
    "updatedAt": "2026-02-11T14:00:30Z"
  },
  {
    "operationID": "op_3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "cash-out",
    "amount": "20000.00",
    "fee": "200.00",
    "distributorTo": "36e48800-22ce-4ea0-b37a-198f7978cd53",
    "distributorName": "PAPSS Distributor",
    "blockchainID": "tx_jkl012...",
    "createdAt": "2026-02-10T16:30:00Z",
    "updatedAt": "2026-02-10T16:30:45Z"
  }
]

Endpoint

GET /api/v1/merchants/{merchantID}/operations

Authentication

Authorization
string
required
Bearer token with your API key. Must have Read Transactions permission.

Path Parameters

merchantID
string
required
The unique identifier of the merchant. Must match the merchant ID associated with the API key.

Query Parameters

limit
integer
default:"100"
Maximum number of operations to return. Maximum value: 1000.
offset
integer
default:"0"
Number of operations to skip for pagination.

Response

Returns an array of operation objects, sorted by creation date (newest first).
operations
array
curl -X GET "https://api.yourdomain.com/api/v1/merchants/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/operations?limit=10&offset=0" \
  -H "Authorization: Bearer uwk_YOUR_API_KEY_HERE"
[
  {
    "operationID": "op_8b7c9d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "cash-in",
    "amount": "50000.00",
    "fee": "0",
    "distributorTo": "36e48800-22ce-4ea0-b37a-198f7978cd53",
    "distributorName": "PAPSS Distributor",
    "memo": "Monthly deposit",
    "blockchainID": "tx_abc123...",
    "createdAt": "2026-02-12T10:30:00Z",
    "updatedAt": "2026-02-12T10:30:15Z"
  },
  {
    "operationID": "op_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "pay-individual",
    "amount": "3000.00",
    "fee": "50.00",
    "phoneTo": "+234 8123456781",
    "memo": "Refund for order #1234",
    "blockchainID": "tx_def456...",
    "createdAt": "2026-02-12T09:15:00Z",
    "updatedAt": "2026-02-12T09:15:20Z"
  },
  {
    "operationID": "op_2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "pay-merchant",
    "amount": "15000.00",
    "fee": "100.00",
    "merchantTo": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
    "merchantName": "Supplier Co.",
    "memo": "Wholesale payment",
    "blockchainID": "tx_ghi789...",
    "createdAt": "2026-02-11T14:00:00Z",
    "updatedAt": "2026-02-11T14:00:30Z"
  },
  {
    "operationID": "op_3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
    "merchantID": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "operationType": "cash-out",
    "amount": "20000.00",
    "fee": "200.00",
    "distributorTo": "36e48800-22ce-4ea0-b37a-198f7978cd53",
    "distributorName": "PAPSS Distributor",
    "blockchainID": "tx_jkl012...",
    "createdAt": "2026-02-10T16:30:00Z",
    "updatedAt": "2026-02-10T16:30:45Z"
  }
]

Operation Types

Funds received from a distributor. The distributorTo and distributorName fields identify the source distributor. Fee is always 0 for cash-in operations.
Funds withdrawn to a distributor. The distributorTo and distributorName fields identify the destination distributor.
Payment sent to another merchant. The merchantTo and merchantName fields identify the destination merchant.
Payment sent to an individual wallet. The phoneTo field identifies the recipient.

Get Balance

Check merchant balance before creating operations

Get Payments

View incoming payments received by this merchant

Create Operation

Create a new merchant operation