API Endpoints

Autogenerated api-docs

Examples

In the examples place close attention to meta fields. This is the same data which is provided while receiving transaction notification (e.g. merchant_meta). You can use this data to match events to specific transactions in your product.

POST /payment-links/

Request

{
    "amount": "10.00",
    "currency": "EUR",
    "meta": {
        "invoice_id": "899"
    },
    "email": "test@local.dev",
    "phone": "+1234510452",
    "department": "//departments/22",
    "shopper": "//customers/89",
    "tokenize": "no",
    "duration": 20160,
    "locale": "en-GB",
    "description": "Description to be shown on pay by link page.",
    "payment_details": {
      "line_items": [
        {
          "quantity": 1,
          "amount_excluding_tax": "0.81",
          "tax_percentage": "24.00",
          "description": "Removal massage tooth.",
          "id": "Item & stuff for invoice #899",
          "tax_amount": "0.19",
          "amount_including_tax": "1.00"
        }
      ]
    }
}

Response

{
  "id": "5114bdd3-5cf6-40bb-acb0-6b7fb3cec50f",
  "amount": "10.0000",
  "shopper": "5b96fc1e-cc62-4478-95ac-5641521d7d9e",
  "department": "b4dc9851-3aac-455c-8e11-bdd9b9e1aa59",
  "store": "9fd16f06-cd4c-4bcc-98c5-47a97dfd6019",
  "currency": "EUR",
  "description": "Description to be shown on pay by link page.",
  "email": "test@local.dev",
  "expires": "2024-04-22T06:30:58Z",
  "phone": "+1234510452",
  "sent": "2024-04-08T06:30:58.780533Z",
  "status": "active",
  "meta": {
    "invoice_id": "899"
  },
  "payment_url": "https://pay.nordhealth-test.com/RiYj4256oAzfsk",
  "allowed_payment_methods": [
    "mc",
    "visa",
    "walley",
    "mobilepay",
    "mc",
    "visa",
    "mobilepay",
    "walley"
  ],
  "blocked_payment_methods": []
}