Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Payees

Get details of a payee

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

get/v1/payees/{payeeId}

Path parameters

payeeIdinteger required

The unique ID of the payee.

Example:346748

Response

An array of payee information

idinteger

Identifier for the fire.com payee bank account (assigned by fire.com).

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.
accountNamestring

The alias attributed to the payee, usually set by the user when creating the payee.

accountHolderNamestring

The name on the payee bank account.

bicstring

The BIC of the account if currency is EUR.

ibanstring

The IBAN of the account if currency is EUR.

nscstring

The Sort Code of the account if currency is GBP.

accountNumberstring

The Account Number of the account if currency is GBP.

combinedAccountNumbersstring

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.

dateCreatedstring date-time

The date the payee was created. ISO Date Time.

Example response

{
  "id": 742,
  "currency": {
    "code": "EUR",
    "description": "Euro"
  },
  "status": "LIVE",
  "accountName": "Joe",
  "accountHolderName": "Joe Bloggs",
  "bic": "BOFIIE2DXXX",
  "iban": "IE86BOFI90535211111111",
  "nsc": "998822",
  "accountNumber": "12345678",
  "createdBy": "CUSTOMER",
  "dateCreated": "2019-08-22T07:48:56.460Z"
}