Returns all your payee bank accounts.
Ordered by payee name ascending.
Can be paginated.
643 matches
27 actions
Fire Financial Services Business
27 actions
Finance/Fire Financial Services Business
Returns all your payee bank accounts.
Ordered by payee name ascending.
Can be paginated.
{
"type": "object",
"properties": {
"fundingSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountHolderName": {
"type": "string",
"description": "The name on the payee bank account."
},
"accountName": {
"type": "string",
"description": "The alias attributed to the payee, usually set by the user when creating the payee."
},
"accountNumber": {
"type": "string",
"description": "The Account Number of the account if currency is GBP."
},
"bic": {
"type": "string",
"description": "The BIC of the account if currency is EUR."
},
"createdBy": {
"type": "string",
"description": "The creation source of the payee.",
"enum": [
"CUSTOMER",
"LODGEMENT",
"DIRECT DEBIT",
"OPEN BANKING",
"FIRE OPEN PAYMENT",
"FIRE DIRECT"
]
},
"currency": {
"type": "object",
"description": "The currency.",
"properties": {
"code": {
"type": "string",
"description": "The three letter code for the currency - either `EUR` or `GBP`.",
"enum": [
"EUR",
"GBP"
]
},
"description": {
"type": "string",
"description": "The name of the currency"
}
}
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "The date the payee was created. ISO Date Time."
},
"iban": {
"type": "string",
"description": "The IBAN of the account if currency is EUR."
},
"id": {
"type": "integer",
"format": "int64",
"description": "Identifier for the fire.com payee bank account (assigned by fire.com)."
},
"nsc": {
"type": "string",
"description": "The Sort Code of the account if currency is GBP."
},
"status": {
"type": "string",
"description": "The status of the payee. Only payees in LIVE status can be selected as a destination account for an outgoing payment.\n * '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.\n * 'LIVE' - The payee can be selected as a destination account for an outgoing payment.\n * 'CLOSED'\n * 'ARCHIVED' - The payee has been deleted and must be added again to be selected as a destination account for an outgoing payment.\n",
"enum": [
"CREATED",
"LIVE",
"CLOSED",
"ARCHIVED"
]
}
}
}
},
"total": {
"type": "integer",
"description": "The total number of payees in the list."
}
}
}