---
title: "Create a payee"
method: POST
path: "/payees"
tags: ["payees"]
---

# Create a payee

`POST /payees`

## Request

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

Requires **payee:create** scope.

## Request body

- PayeePost
  - `sortCode` string, required: The sort code of the payee
  - `accountNumber` string, required: The account number of the payee
  - `name` string, required: The name of the payee
  - `displayName` string: The name of the payee to display the end user
  - `externalId` string: External ID of the payee
  - `userId` string, nullable: User ID of the payee

## Response `200`

Successful Payee Response

- object
  - `data` Payee
    - `id` string, uuid, required: The id of the payee
    - `clientId` string, uuid, required: The id of the client
    - `sortCode` string, required: The sort code of the payee
    - `accountNumber` string, required: The account number of the payee
    - `createdAt` string, date-time, required: The date that the payee was created.
    - `modifiedAt` string, date-time, required: The date that the payee was modified.
    - `active` boolean, required: Determines if payee is active
    - `name` string, required: The name of the payee
    - `displayName` string: The name of the payee to display the end user
    - `externalId` string, nullable, required: External ID of the payee
    - `userId` string, nullable: User ID of the payee
  - `meta` object

## Other responses

- `400`: Unsuccessful Response - Bad request - Missing query parameters - Missing body properties
- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes

## Changes

- **2026-11-03** `e004d9ee1fdb`: 6 warning
  - removed the optional property `id` from the response with the `400` status
  - removed the optional property `id` from the response with the `401` status
  - removed the optional property `id` from the response with the `403` status
  - removed the optional property `userId` from the response with the `400` status
  - …2 more

[Operation history](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/changes/payees/post.md)

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/revisions/e004d9ee1fdb?raw)