Get an order
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.
apiKeyAuthorizationBasic <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.
order_id*stringThe id of the order.
uuidThe order.
application/json- response
id?stringOrder ID.
uuidproject_id?stringID of the project the order belongs to.
uuidmerchant_id?stringID of your merchant account.
uuidmerchant_order_id?stringYour own order reference. Recommended.
merchant_name?stringYour merchant name. Can be used for payouts, if configured.
description?stringDescription of the order. Recommended.
currency*CurrencyISO 4217 currency code, such as EUR, GBP or USD. Get supported currencies lists the currencies of your project.
^[A-Z]{3}$amount*AmountAmount in the smallest currency unit, including VAT. 1234 is € 12.34. For currencies without minor units, send the whole amount.
0 <= valuestatus?stringStatus of the order. completed, cancelled, expired and error are final. With see-transactions, the transactions have different statuses: check each of them. See Order statuses.
"new""processing""completed""cancelled""expired""error""see-transactions"flags?array<string>Labels of the order, such as is-test for orders in a test project and is-refund for refund orders.
created?TimestampDate and time in ISO 8601 format.
date-timemodified?TimestampDate and time in ISO 8601 format.
date-timecompleted?TimestampDate and time in ISO 8601 format.
date-timeexpiration_period?DurationHow long the order stays valid, such as PT1H for one hour.
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?stringThe hosted payment page of the order. Redirect your customer here when you didn't send a transaction.
urireturn_url?stringWhere your customer goes after the payment. Recommended.
urifailure_url?stringWhere your customer goes when the payment fails, with status cancelled, expired or error. Without it, your customer goes to the return_url.
uriwebhook_url?stringWhere webhooks for this order are sent. Overrides the webhook URL of your project.
uricustomer?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.
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.
refunded_amount?integerThe amount refunded on this order so far, in the smallest currency unit.
refund_of_order_id?stringFor a refund order, the ID of the original order.
uuidrefund_orders?array<>IDs of the refund orders of this order.
capture_of_order_id?stringFor a capture order, the ID of the original order.
uuidvoid_of_order_id?stringFor a void order, the ID of the original order.
uuidchargeback_of_order_id?stringFor a chargeback order, the ID of the original order.
uuidchargeback_orders?array<>IDs of the chargeback orders of this order.
reversal_of_order_id?stringFor a reversal order, the ID of the original order.
uuidreversal_orders?array<>IDs of the reversal orders of this order.
related_order_id?stringID of the original order, for any order created from another one.
uuidrelated_orders?array<>IDs of the orders created from this order.
related_payment_link_id?stringID of the payment link the order was created from.
uuidcurl -X GET 'https://api.dev.gingerpayments.com/v1/orders/8078d78f-8700-4cfe-94b1-4a777d3400f2/'{ "id": "4c6afd74-a840-4aab-b411-1e6e0636d341", "project_id": "05ad138f-52fa-40dc-9751-5fde949dcb57", "merchant_id": "b251b220-5d8b-4b9d-9915-b89676dc0948", "merchant_order_id": "EXAMPLE001", "created": "2026-09-20T08:51:10.078503+00:00", "modified": "2026-09-20T08:52:02.357623+00:00", "completed": "2026-09-20T08:52:02.357623+00:00", "currency": "EUR", "amount": 100, "description": "Example order", "status": "completed", "flags": [ "is-test" ], "return_url": "https://www.example.com/order/EXAMPLE001", "transactions": [ { "id": "6a0bdf56-53c3-4ce3-8189-4a73d775ac66", "order_id": "4c6afd74-a840-4aab-b411-1e6e0636d341", "currency": "EUR", "amount": 100, "credit_debit": "credit", "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", "liability_shift": true }, "events": [ { "event": "new", "id": "3cb2259b-a3f9-4908-bb98-eb51c773fc70", "occurred": "2026-09-20T08:51:10.091203+00:00", "noticed": "2026-09-20T08:51:10.104112+00:00", "source": "set_status" }, { "event": "accepted", "id": "7d6f0e4c-2f69-4d4b-9a51-58a3b8a2f0c1", "occurred": "2026-09-20T08:52:02.341870+00:00", "noticed": "2026-09-20T08:52:02.350211+00:00", "source": "set_status" } ], "outcomes": { "processing": { "status": "accepted", "response_code": "00", "response_code_description": "Approved" } }, "is_capturable": false, "status": "accepted" } ]}