Sign in

v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
pay-links

Create a pay-link

Requires pay_link:create scope.

post/pay-links

Request body

widgetIdstring uuid required

The id of the widget used to render the pay-link

payeeIdstring uuid

The id of the payee

referencestring required

Reference to display on payer's statement

amountinteger required

Payment amount in minor units of the currency, eg. pennies for GBP.

endToEndIdstring nullable

Unique identifier relevant to the transaction - Allowed characters (a-zA-Z0-9 :-).

useOnceboolean

Boolean to indicate if the pay-link can only be consumed once. Defaults to false.

expiresAtstring date-time nullable

The date the pay-link will expire

Example request

{
  "widgetId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
  "payeeId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
  "payee": {
    "sortCode": "123456",
    "accountNumber": "12345678",
    "name": "Payee 1",
    "displayName": "Payee One"
  },
  "reference": "Payer ref",
  "amount": 1500,
  "endToEndId": "Moneyhub-2024",
  "expiresAt": "2021-02-01T11:08:45.574Z"
}

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