---
title: "Get details of a payee"
method: GET
path: "/v1/payees/{payeeId}"
tags: ["Payees"]
---

# Get details of a payee

`GET /v1/payees/{payeeId}`

This endpoint will retrieve the details of a specific payee. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCE to use this endpoint.

## Path parameters

- `payeeId` integer, required — The unique ID of the payee.

## Response `200`

An array of payee information

- Payee
  - `id` integer — Identifier for the fire.com payee bank account (assigned by fire.com).
  - `currency` Currency — The currency.
    - `code` string — The three letter code for the currency.
    - `description` string — The name of the currency
  - `status` 'CREATED' | 'LIVE' | 'CLOSED' | 'ARCHIVED' — The status of the payee. Only payees in LIVE status can be selected as a destination account for an outgoing payment. * 'CREATED' - The payee has been set-up via Bank Transfer Received, Direct Debit, or Open Banking. This payee must be converted to LIVE status to select as a destination account for an outgoing payment. * 'LIVE' - The payee can be selected as a destination account for an outgoing payment. * 'CLOSED' * 'ARCHIVED' - The payee has been deleted and must be added again to be selected as a destination account for an outgoing payment.
  - `accountName` string — The alias attributed to the payee, usually set by the user when creating the payee.
  - `accountHolderName` string — The name on the payee bank account.
  - `bic` string — The BIC of the account if currency is EUR.
  - `iban` string — The IBAN of the account if currency is EUR.
  - `nsc` string — The Sort Code of the account if currency is GBP.
  - `accountNumber` string — The Account Number of the account if currency is GBP.
  - `combinedAccountNumbers` string — BIC and IBAN for domestic payees. Account numbers for international payees
  - `createdBy` 'CUSTOMER' | 'LODGEMENT' | 'DIRECT_DEBIT' | 'OPEN_BANKING' | 'FIRE_OPEN_PAYMENT' | 'FIRE_DIRECT' | 'PAYMENT_ORIGINATING_OVERSEAS' — The creation source of the payee.
  - `dateCreated` string, date-time — The date the payee was created. ISO Date Time.

## Other responses

- `400` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `401` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `403` — An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

---

[API](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api.md) · [All operations](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefinancialservices/fire-financial-services-business-api/versions/1d19896d095c/schema)