v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

pay-links

Retrieve one pay-link created by an API client

Requires pay_link:read scope.

get/pay-links/{payLinkId}

Path parameters

payLinkIdstring uuid required

The pay-link Id

Response

Successful PayLink Response

metaobject

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"
  }
}