Sign in
latestOpenAPI 3.0.12026-08-108798310.5 KB

fa1a72b9ecec

Payees

Create a payee

put/api/v2/payees

Request body

payeeNamestring required

Name

phoneNumberstring

Phone number

payeeType'BUSINESS' | 'INDIVIDUAL' required
firstNamestring

First name

middleNamestring

Middle name

lastNamestring

Last name

businessNamestring

Business name

dateOfBirthstring date

Date of birth for this payee

Example request

{
  "payeeName": "Bob Bobbington",
  "phoneNumber": "+447700900123",
  "payeeType": "INDIVIDUAL",
  "firstName": "Bob",
  "middleName": "Bobity",
  "lastName": "Bobbington",
  "businessName": "Trotters Independent Traders",
  "dateOfBirth": "2023-01-01",
  "accounts": [
    {
      "description": "Bob's business account",
      "defaultAccount": true,
      "countryCode": "GB",
      "accountIdentifier": "12345678",
      "bankIdentifier": "123456",
      "bankIdentifierType": "SORT_CODE"
    }
  ]
}

Response

Successful operation

payeeUidstring

The newly created payee unique identifier, only present on successful payee creation

successboolean

True if the method completed successfully

Example response

{
  "payeeUid": "55665566-5566-5566-5566-556655665566",
  "success": true,
  "errors": [
    {
      "message": "Something about the error"
    }
  ]
}