Payment Links

With the Payment Links integration, you can create payment links that you can send to your users. The user can then pay with the link by a digital bank transfer. After the payment is completed, the money will be transferred to your bank account directly or to an Ivy settlement account.

Integration Steps

1. Create a Checkout Session

Create a Checkout Session with the POST /checkout/session/create endpoint. You can specify the amount, currency, and referenceId, which is unique to your system. In addition, you can set the link's expiration date with the expiresAt attribute.

Example Request Payload

{
   "price": {
     "total": 100.00,
      "currency": "EUR"
    },
    "referenceId": "1234567890",
    "successCallbackUrl": "https://your-website.com/success",
    "errorCallbackUrl": "https://your-website.com/failure"
  }

2. Send the Payment Link to the User

You receive a redirectUrl in the response. The redirectUrl is the URL you can send to your user. The user can simply click the redirectUrl and pay the link with a digital bank transfer.

Example

{
  "id": "64d1e370c23b4b4c00cac352",
  "price": {
    "total": 100.0,
    "currency": "EUR"
  },
  "referenceId": "1234567890",
  "redirectUrl": "https://checkout.getivy.de?session=64d1e370c23b4b4c00cac352",
}

You can retrieve the payment status either by polling the status or by listening to Ivy Webhooks. Please read more about this in the Status Updates section.