RequestToPay

PayeeNamestringrequired

Example: Utility Company Ltd

PayerIdentifierstringrequired

Proxy ID, Email, or Mobile Number of the person being asked to pay.

Example: +447123456789

AmountRequested objectrequired

Amountstringrequired

Possible values: Value must match regular expression ^\d{1,13}\.\d{1,5}$

Example: 150.00

Currencystringrequired

Possible values: Value must match regular expression ^[A-Z]{3,3}$

Example: GBP

DueDatestring<date>required

Example: 2026-08-01

Referencestring

Example: Electric Bill July

RequestToPay

{
  "PayeeName": "Utility Company Ltd",
  "PayerIdentifier": "+447123456789",
  "AmountRequested": {
    "Amount": "150.00",
    "Currency": "GBP"
  },
  "DueDate": "2026-08-01",
  "Reference": "Electric Bill July"
}