MOmoneyhubenterprise
payees

Create a payee

Changed on

Requires payee:create scope.

post/payees

Request

  • Base URL
    https://identity.moneyhub.co.uk
  • URL
    https://identity.moneyhub.co.uk/payees
  • Auth
    API key in header Authorization

Request body

sortCodestring required

The sort code of the payee

accountNumberstring required

The account number of the payee

namestring required

The name of the payee

displayNamestring

The name of the payee to display the end user

externalIdstring

External ID of the payee

userIdstring nullable

User ID of the payee

Example request

{
  "sortCode": "123456",
  "accountNumber": "12345678",
  "name": "Payee 1",
  "displayName": "Payee One",
  "externalId": "external-id",
  "userId": "5349b4ddd2781d08c09890f3"
}

Response

Successful Payee Response

metaobject

Example response

{
  "data": {
    "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
    "clientId": "91d62867-a8a8-4146-8a5b-d4e61227db21",
    "sortCode": "123456",
    "accountNumber": "12345678",
    "createdAt": "2018-07-10T12:00:00+00:00",
    "modifiedAt": "2018-08-10T12:00:00+00:00",
    "name": "Payee 1",
    "displayName": "Payee One",
    "externalId": "external-id",
    "userId": "5349b4ddd2781d08c09890f3"
  }
}

Changes

  • e004d9ee1fdbRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status