List all payment links - Lopay Partner API

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

offsetId

string <uuid>

optional

Optional. ID of last payment link in current response.

Example:

c689b77a-d47d-4d02-b037-6f49509f759b

pageSize

number

optional

Optional - default 20. Number of payment links to return.

<= 100> 0

Example:

20

status[]

array[string]

optional

Optional. By default, all payment links will show.

Allowed values:

pendingcancelledcompleted

Example:

["completed"]

Header Params

x-merchant-id

string <uuid>

Merchant ID

optional

If acting on behalf of a merchant, you will need to specify their merchant ID.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

OK response

Body

offsetId

string <uuid> | null

optional

pageSize

number

required

count

number

required

data

array [object {13}]

required

id

string <uuid>

required

merchantId

string <uuid>

required

status

enum<string>

required

Allowed values:

pendingcancelledcompleted

link

string <uri>

required

amount

object

required

description

string

required

reference

string | null

required

dataCollection

array[string]

required

Allowed values:

namebusinessNamephoneNumberemailaddress

taxes

array [object {3}]

required

payments

array [object {9}]

required

returnUrl

string <uri> | null

required

createdAt

string

required

updatedAt

string

required

Examples

No offsetIdWith offsetId

{
  "pageSize": 1,
  "count": 2,
  "data": [
    {
      "id": "dd82c9e8-63a2-45a2-9e74-6d82c5b22c65",
      "merchantId": "8e272ef4-4fba-4ec7-a414-9e8907a71faf",
      "amount": {
        "units": 15000,
        "currencyCode": "GBP"
      },
      "link": "https://lopay.app/08adf/b9f0bc31-4209-4bbb-bf1d-2ea124031056",
      "reference": null,
      "description": "Payment for INV#1000 (Gary Smith)",
      "status": "pending",
      "dataCollection": [
        "name"
      ],
      "taxes": [],
      "payments": [],
      "returnUrl": null,
      "createdAt": "2024-08-05T15:23:08.194Z",
      "updatedAt": "2024-08-05T15:23:08.194Z"
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized