API Documentation

v1.0.0 • REST API Reference

Live
Last updated: 2 hours ago
GET/api/v1/escrow/transactions

Retrieve a list of escrow transactions, specifically for sales, with the ability to paginate the results

Base URL:https://api.payluk.ng

Parameters

NameTypeRequiredDescription
typestringOptionalFilter by transaction type (sales, buy)
pageintegerOptionalPage number for pagination
limitintegerOptionalNumber of items per page

Responses

200Transaction fetched successfully
401Unauthorized - Invalid or missing token

Example

Request

curl -X GET "{{base_url}}api/v1/escrow/transactions?type=sales&page=1&limit=5" \
  -H "Authorization: Bearer sk_live_jeH0SxdvDhZu0sKcPUAsXassg0tVVAwP"

Response

{
  "status": 200,
  "message": "Transaction fetched successfully",
  "data": {
    "data": [
      {
        "amount": 6000,
        "purpose": "Purpose",
        "description": "Description",
        "whoPays": "seller",
        "status": "PENDING",
        "state": "AWAITING_PAYMENT",
        "paymentToken": "PY_fzKggjWo4248"
      }
    ],
    "pagination": {
      "count": 10,
      "pages": 2,
      "isLastPage": false,
      "nextPage": 2
    }
  }
}

Try it out

Test this endpoint with your API credentials