Rabobank Docs

Get a payment link

GET
/v1/paymentlinks/{payment_link_id}/

Retrieves a payment link with its status and every order created from it, by order ID with its status.

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

Response Body

The payment link.

application/json
  1. response
id?string

Payment link ID.

Formatuuid
project_id?string
Formatuuid
merchant_id?string
Formatuuid
merchant_order_id*string

Your own order reference.

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
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}$
description?string

Description 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?Duration

How long the link stays valid, such as P20D for 20 days. The default is 30 days.

return_url?string

Where your customer goes after paying.

Formaturi
failure_url?string

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

Formaturi
webhook_url?string

Where status changes of the orders created from the link are sent.

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.

extra?

Your own data to store with the link. It's copied to every order created from it.

merchant_bank_account_id?string

One of the secondary bank accounts configured for your merchant account, to receive the payment on.

payment_url?string

The link to send to your customer. Every visit creates a new order on the hosted payment page, until the link is paid or expires.

Formaturi
status?string
  • new: 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.
Value in"new""processing""completed""expired""all_unsuccessful"
reason?string

Why the link has its current status.

completed_order_id?string

ID of the order that was paid.

Formatuuid
orders?

The orders created from the link, by order ID, with the status of each order.

processing_orders?array<>

IDs of the orders created from the link that are still being paid. Only present when there are any. A link allows at most 5 at a time.

payment_completed_url?string

The hosted payment page of the order that was paid, where your customer is sent when opening a link that's already paid. Only present once the link is completed.

Formaturi
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
curl -X GET 'https://api.prod.smartpay.gingerpayments.com/v1/paymentlinks/a8c1b7b0-9c73-4bd8-94f4-37c3070e78c7/' \  --user "$API_KEY:"
{  "id": "a8c1b7b0-9c73-4bd8-94f4-37c3070e78c7",  "merchant_order_id": "EXAMPLE001",  "amount": 995,  "currency": "EUR",  "description": "Invoice EXAMPLE001",  "expiration_period": "P20D",  "payment_url": "https://api.prod.smartpay.gingerpayments.com/paymentlinks/a8c1b7b0-9c73-4bd8-94f4-37c3070e78c7/",  "created": "2026-10-12T15:39:12.773776Z",  "modified": "2026-10-12T16:18:37.196467Z",  "completed": "2026-10-12T16:18:32.574222Z",  "completed_order_id": "3bb663cc-2a20-400d-8bf6-18d9695d0c66",  "orders": {    "0d79014c-0aaa-4fd6-87c5-c8cfa5f5ac69": "error",    "3bb663cc-2a20-400d-8bf6-18d9695d0c66": "completed"  },  "payment_completed_url": "https://api.prod.smartpay.gingerpayments.com/pay/3bb663cc-2a20-400d-8bf6-18d9695d0c66/select-payment-method/",  "payment_methods": [    "credit-card",    "apple-pay",    "google-pay"  ],  "return_url": "https://www.example.com/thank-you",  "webhook_url": "https://www.example.com/webhook",  "status": "completed",  "reason": "Payment Link was visited and at least 1 related order was completed"}