Get a payment link
Retrieves a payment link with its status and the IDs of every order created from it, grouped by order status.
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.
payment_link_id*stringThe id of the payment link.
uuidThe payment link.
application/json- response
id?stringPayment link ID.
uuidproject_id?stringuuidmerchant_id?stringuuidmerchant_order_id*stringYour own order reference.
amount*AmountAmount in the smallest currency unit, including VAT. 1234 is € 12.34. For currencies without minor units, send the whole amount.
0 <= valuecurrency*CurrencyISO 4217 currency code, such as EUR, GBP or USD. Get supported currencies lists the currencies of your project.
^[A-Z]{3}$description?stringDescription of the payment. Without it, the orders have no description.
payment_methods?array<>Payment methods to show on the hosted payment page. Without it, every active payment method is shown.
expiration_period?DurationHow long the link stays valid, such as P20D for 20 days. The default is 30 days.
return_url?stringWhere your customer goes after paying.
uriwebhook_url?stringWhere status changes of the orders created from the link are sent.
uripayment_url?stringThe link to send to your customer.
uristatus?stringnew: your customer hasn't tried to pay yet.processing: a payment is in progress.all_unsuccessful: every attempt so far failed. Your customer can try again until the link expires.completed: one of the attempts succeeded.expired: the link expired without a successful payment.
"new""processing""completed""expired""all_unsuccessful"reason?stringWhy the link has its current status.
completed_order_id?stringID of the order that was paid.
uuidorders?IDs of the orders created from the link, grouped by order status.
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-timecurl -X GET 'https://api.dev.gingerpayments.com/v1/paymentlinks/a8c1b7b0-9c73-4bd8-94f4-37c3070e78c7/'{ "id": "a8c1b7b0-9c73-4bd8-94f4-37c3070e78c7", "merchant_order_id": "EXAMPLE001", "amount": 995, "currency": "EUR", "description": "Invoice EXAMPLE001", "expiration_period": "P20D", "payment_url": "https://api.dev.gingerpayments.com/paylink/a8c1b7b0-9c73-4bd8-94f4-37c3070e78c7/", "created": "2026-10-12T15:39:12.773776+00:00", "modified": "2026-10-12T16:18:37.196467+00:00", "completed": "2026-10-12T16:18:32.574222+00:00", "completed_order_id": "3bb663cc-2a20-400d-8bf6-18d9695d0c66", "orders": { "error": [ "0d79014c-0aaa-4fd6-87c5-c8cfa5f5ac69" ], "completed": [ "3bb663cc-2a20-400d-8bf6-18d9695d0c66" ] }, "status": "completed", "reason": "Completed"}