Rabobank Docs

Get an order

GET
/v1/orders/{order_id}/

Retrieves an order with all of its transactions. Retrieve the order when your customer returns to your return_url, when you receive a webhook, and periodically for orders that aren't final yet.

See Order and transaction status for which status to check.

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.

Path Parameters

order_id*string

The id of the order.

Formatuuid

Response Body

The order.

application/json
  1. response
id*string

Order ID.

Formatuuid
project_id*string

ID of the project the order belongs to.

Formatuuid
merchant_id*string

ID of your merchant account.

Formatuuid
merchant_order_id?string

Your own order reference, shown in the merchant portal. Recommended.

description?string

Description of the order. Recommended.

currency*Currency

ISO 4217 currency code, such as EUR, GBP or USD. Get supported currencies lists the currencies of your project.

Match^[A-Z]{3}$
amount*Amount

Amount in the smallest currency unit, including VAT. 1234 is € 12.34. For currencies without minor units, send the whole amount.

Range0 <= value
status*string

Status of the order. completed, cancelled, expired and error are final. See Order statuses.

Value in"new""processing""completed""cancelled""expired""error"
flags?array<string>

Labels of the order, such as is-test for orders in a test project and is-refund for refund orders.

created*Timestamp

Date and time in ISO 8601 format.

Formatdate-time
modified*Timestamp

Date and time in ISO 8601 format.

Formatdate-time
completed?Timestamp

Date and time in ISO 8601 format.

Formatdate-time
last_transaction_added?string

When the latest transaction was added to the order.

Formatdate-time
expiration_period?Duration

How long the order stays valid, such as PT1H for one hour.

capture_mode?string

Makes every transaction of the order a pre-authorization. Without it, the amount is captured right away. A capture_mode on a transaction overrides it.

  • manual: the amount is reserved until you capture or void it.
  • delayed: the amount is captured automatically when the expiration_period ends.
Value in"manual""delayed"
payment_methods?array<|>

The payment methods to show on the hosted payment page. Without it, every payment method that's active in your project is shown.

transactions?array<>

The payment attempts of the order. When you create the order, send one transaction to pick the payment method yourself. Without it, your customer picks a payment method on the hosted payment page.

order_url?string

The hosted payment page of the order. Redirect your customer here when you didn't send a transaction.

Formaturi
return_url?string

Where your customer goes after the payment, or after 3-D Secure authentication in your own checkout. Without it, your customer stays on the Rabobank result page. Recommended.

Formaturi
failure_url?string

Where your customer goes when the payment fails, with status cancelled, expired or error. Without it, your customer goes to the return_url.

Formaturi
webhook_url?string

Where webhooks for this order are sent. Overrides the webhook URL of your project.

Formaturi
customer?

Your customer. Card schemes use these details for 3-D Secure risk assessment, so complete details lead to more frictionless payments. Your acquirer can require some of them.

order_lines?array<>

The items of the order. Optional for card payments.

client?

The software that sends the request, such as your e-commerce platform or plugin.

extra?

Your own data to store with the order. It's returned when you retrieve the order.

merchant_tags?

Key-value tags copied from your merchant account when the order was created.

events?array<>

Log of what happened to the order. See Transaction events for the events of each transaction.

refunded_amount?integer

The amount refunded on this order so far, in the smallest currency unit.

refund_of_order_id?string

For a refund order, the ID of the original order.

Formatuuid
refund_orders?array<>

IDs of the refund orders of this order.

capture_of_order_id?string

For a capture order, the ID of the original order.

Formatuuid
void_of_order_id?string

For a void order, the ID of the original order.

Formatuuid
chargeback_of_order_id?string

For a chargeback order, the ID of the original order.

Formatuuid
chargeback_orders?array<>

IDs of the chargeback orders of this order.

reversal_of_order_id?string

For a reversal order, the ID of the original order.

Formatuuid
reversal_orders?array<>

IDs of the reversal orders of this order.

related_payment_link_id?string

ID of the payment link the order was created from.

Formatuuid
curl -X GET 'https://api.prod.smartpay.gingerpayments.com/v1/orders/8078d78f-8700-4cfe-94b1-4a777d3400f2/' \  --user "$API_KEY:"
{  "id": "23cd147d-cd2b-4df6-ae50-199de346ded1",  "project_id": "05ad138f-52fa-40dc-9751-5fde949dcb57",  "merchant_id": "b251b220-5d8b-4b9d-9915-b89676dc0948",  "merchant_order_id": "EXAMPLE001",  "created": "2026-10-12T10:43:13.905092+00:00",  "modified": "2026-10-12T10:44:02.357623+00:00",  "completed": "2026-10-12T10:44:02.357623+00:00",  "last_transaction_added": "2026-10-12T10:43:13.905092+00:00",  "currency": "EUR",  "amount": 995,  "description": "Example card order",  "status": "completed",  "flags": [    "is-test"  ],  "expiration_period": "PT1H",  "return_url": "https://www.example.com/order/EXAMPLE001",  "webhook_url": "https://www.example.com/webhook",  "transactions": [    {      "id": "12774973-2ff1-49f5-926c-b5dc471ee96b",      "order_id": "23cd147d-cd2b-4df6-ae50-199de346ded1",      "project_id": "05ad138f-52fa-40dc-9751-5fde949dcb57",      "merchant_id": "b251b220-5d8b-4b9d-9915-b89676dc0948",      "created": "2026-10-12T10:43:13.905092+00:00",      "modified": "2026-10-12T10:44:02.341870+00:00",      "completed": "2026-10-12T10:44:02.341870+00:00",      "currency": "EUR",      "amount": 995,      "credit_debit": "credit",      "expiration_period": "PT30M",      "is_capturable": false,      "payment_method": "credit-card",      "payment_method_brand": "visa",      "payment_method_details": {        "truncated_pan": "414141******4141",        "card_expiry": "012030",        "cardholder_name": "John Smith",        "vault_token": "e3ed069e-c931-40ae-8035-e022e8a4e5e7"      },      "events": [        {          "event": "new",          "id": "3cb2259b-a3f9-4908-bb98-eb51c773fc70",          "occurred": "2026-10-12T10:43:13.905092+00:00",          "noticed": "2026-10-12T10:43:13.918112+00:00",          "source": "set_status"        },        {          "event": "accepted",          "id": "7d6f0e4c-2f69-4d4b-9a51-58a3b8a2f0c1",          "occurred": "2026-10-12T10:44:02.341870+00:00",          "noticed": "2026-10-12T10:44:02.350211+00:00",          "source": "set_status"        }      ],      "outcomes": {        "processing": {          "status": "accepted",          "response_code": "00",          "response_code_description": "Approved"        }      },      "status": "accepted"    }  ],  "customer": {    "merchant_customer_id": "123456789",    "email_address": "user@example.com",    "first_name": "John",    "last_name": "Smith",    "address_type": "billing",    "address": "100 Main Street",    "postal_code": "SW1A 1AA",    "city": "London",    "country": "GB",    "locale": "en-GB",    "phone_numbers": [      "+441234566788"    ],    "ip_address": "192.0.2.1",    "ip_country": "GB"  }}