For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Transactions

List all transactions for your business.

Returns all transactions (on-ramp, off-ramp) for your business with pagination and filtering.

Endpoint

GET /v1/transactions

Authentication

Accepts either a merchant API key or a business-user JWT.

Header
Value

Authorization

<api_key> or Bearer <jwt>

Query parameters

Parameter
Type
Required
Description

startPeriodDatetime

string

No

Start of date range (ISO 8601)

endPeriodDatetime

string

No

End of date range (ISO 8601)

page

number

No

Page number (default: 1)

limit

number

No

Items per page (default: 10, max: 100)

q

string

No

Full-text search across reference, email, names, phone and refCode

Example request

curl -X GET "https://ramp-api.ivorypay.io/api/v1/transactions?page=1&limit=20" \
  -H "Authorization: your_api_key"
const params = new URLSearchParams({
  page: "1",
  limit: "20",
});

const response = await fetch(`https://ramp-api.ivorypay.io/api/v1/transactions?${params}`, {
  method: "GET",
  headers: {
    "Authorization": "your_api_key",
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/transactions",
    headers={
        "Authorization": "your_api_key",
    },
    params={
        "page": 1,
        "limit": 20,
    },
)

print(response.json())

Example response

Pagination

The endpoint accepts the page and limit query parameters (default limit=10, max 100). However, the API currently does not emit a meta pagination wrapper in the response body — only the data array is returned. Use the length of data and your supplied page/limit to manage pagination on the client.

Transaction features

Feature
Description

ON_RAMP

Fiat → Crypto

OFF_RAMP

Crypto → Fiat

Last updated