v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

pay-links

Retrieve all pay-links created by an API client

Requires pay_link:read scope. Default limit is set to 10.

get/pay-links

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

widgetIdstring uuid

The ID of the widget to filter pay-links on

payeeIdstring uuid

The ID of the payee to filter pay-links on

isActiveboolean

Filter for active pay-links (not expired and unused if one-time use).

Response

Successful PayLink Response

Example response

{
  "data": [
    {
      "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "clientId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
      "widgetId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
      "payeeId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
      "reference": "Payer ref",
      "amount": 1500,
      "endToEndId": "Moneyhub-2024",
      "usedAt": "2021-02-01T11:08:45.574Z",
      "archivedAt": "2021-02-01T11:08:45.574Z",
      "expiresAt": "2021-02-01T11:08:45.574Z",
      "createdAt": "2018-07-10T12:00:00+00:00",
      "updatedAt": "2018-08-10T12:00:00+00:00"
    }
  ]
}