Rabobank Docs

Search orders

POST
/v1/search/orders/

Finds orders with a query and returns them as JSON, or as a CSV transaction report with ?format=csv.

Simple paging with start and size returns at most 10,000 results. Use search_after for more.

Authorization

apiKey
headerAuthorizationBasic <token>

Use your project's API key as the username and leave the password empty. Only use the API key from your server: it gives full access to your project.

Query Parameters

format?"csv"

csv returns a CSV report instead of JSON.

Value in"csv"

Request Body

application/json
  1. body
query*string

Search query. * matches all orders. Filter on a field with field:value, such as status:completed, or on a range with field:[from TO to], such as created:[2026-09-01 TO 2026-09-01].

size?integer

Number of results per page. Use the same value in every request.

Range1 <= value
start?integer

Position of the first result, for simple paging. Don't combine with search_after.

sort?string

Field and direction to sort on, such as created asc. Use the same value in every request.

search_after?string

Cursor for paging through more than 10,000 results. -1 for the first page, then the value of the sort field of the last order of the previous page. Don't combine with start.

Response Body

The matching orders, as JSON or as a CSV report with one row per transaction.

  1. response
hits*integer

Total number of orders that match the query, across all pages.

orders*array<>

The orders of this page.

curl -X POST 'https://api.prod.smartpay.gingerpayments.com/v1/search/orders/' \  --user "$API_KEY:" \  -H 'Content-Type: application/json' \  -d '{  "query": "*",  "size": 100,  "start": 1,  "sort": "created asc"}'
{  "hits": 1,  "orders": [    {      "id": "8bb4c444-66ea-4eba-b7c8-fb7ae32bb4fe",      "project_id": "05ad138f-52fa-40dc-9751-5fde949dcb57",      "merchant_id": "b251b220-5d8b-4b9d-9915-b89676dc0948",      "merchant_order_id": "EXAMPLE001",      "created": "2026-10-09T10:43:13.905092+00:00",      "modified": "2026-10-09T10:43:15.112340+00:00",      "completed": "2026-10-09T10:43:15.112340+00:00",      "currency": "GBP",      "amount": 995,      "status": "completed",      "transactions": [        {          "id": "e0b704ee-e0de-4aec-9e4c-dc597e54418d",          "order_id": "8bb4c444-66ea-4eba-b7c8-fb7ae32bb4fe",          "payment_method": "credit-card",          "payment_method_brand": "visa",          "amount": 995,          "currency": "GBP",          "status": "accepted"        }      ]    }  ]}