Several fields on the Client API accept only a fixed set of values, but the generated API Reference types them as plain strings, so the allowed values are not visible on the endpoint pages. They are collected here. Send them exactly as written, including capitalisation.
Two naming conventionsMost values are PascalCase (
Fps,Credit,Sent). The cancellationreasonvalues are the exception and are lower snake case (incorrect_amount). Sort keys and sort directions are camelCase and lower case respectively.
Payments
| Field | Where | Allowed values |
|---|---|---|
paymentMethod | POST /v1/outbound-payments | Fps, Chaps, Swift, Sepa |
chargeType | POST /v1/outbound-payments | OUR is the default. Swift payments only. Sending it on any other rail is rejected. |
status | GET /v1/outbound-payments filter, and the status field on a payment | Scheduled, AwaitingFunds, Processing, Sent, Rejected, Returned, Cancelled |
reason | POST /v1/outbound-payments/{id}/cancel | incorrect_amount, incorrect_payee, payment_not_required |
paymentMethod is optional. Leave it out and the rail is resolved from what the payee and the account support, which is usually what you want. An explicit value is rejected when the rail is disabled for you, unsupported for that payee or account, or when the transfer is really an internal IBANQ-to-IBANQ movement. Use POST /v1/internal-payments for that. See Payment lifecycle and statuses for what each status means.
FX
| Field | Where | Allowed values |
|---|---|---|
fixedSide | POST /v1/fx/quotes, and on the returned quote | Buy, Sell |
Buy fixes the amount of buyCurrency you receive; Sell fixes the amount of sellCurrency you spend. The other side is whatever the rate produces.
Transactions
| Field | Where | Allowed values |
|---|---|---|
direction | GET /v1/transactions filter and response | Credit, Debit |
currency | Everywhere | ISO 4217 three-letter codes in upper case. GET /v1/reference/currencies is the authoritative list. |
Sorting
orderDirection is asc or desc on every list endpoint. orderBy differs by resource.
| Endpoint | orderBy values | Default |
|---|---|---|
GET /v1/accounts | clientName, accountNumber, iban, parentName | clientName, asc |
GET /v1/transactions | date, amount | date, desc |
OAuth scopes
Scopes are requested in the scope parameter of the token request, space separated. Ask only for what the call needs. A token missing a scope fails with 403 insufficient_scope.
| Scope | Grants |
|---|---|
accounts:read | Read accounts and balances |
accounts:write | Manage accounts |
payments:read | Read outbound, inbound and internal payments |
payments:write | Create and cancel outbound payments; create internal payments |
payees:read | Read payees |
payees:write | Create, update and delete payees |
fx:read | Read FX trades |
fx:quote | Request FX quotes |
fx:trade | Book FX trades |
verifications:check | Run account name verification checks |
webhooks:manage | Reserved; webhook endpoints are managed by your account manager and there are no client-facing endpoints yet. |
events:read | Read the events raised for your clients (GET /v1/events). |
Other closed sets
| Field | Where | Allowed values |
|---|---|---|
type | POST /v1/payees request and payee | Individual, Business |
accountType | POST /v1/account-name-verifications request | Personal, Business |
accountType | On an account | VirtualAccount (others may be added) |
domesticBankCodeType | On a payee | ABARoutingNumber, BSBNumber, ClearingCode, IFSCCode, LocalBankOrClearingCode, SortCode, SwiftBic |
channel | On payees, payments and trades | Portal, Api, Brokered |
scheme | On an account name verification, and a payee's accountNameVerification | ConfirmationOfPayee |
answer | On an account name verification, and a payee's accountNameVerification | Match, CloseMatch, NoMatch, Unavailable |
reasonCode | On an account name verification | UK Confirmation of Payee reason codes; AC01 (account does not exist) blocks payee creation |
chargeType | POST /v1/outbound-payments, Swift only | OUR (default), SHA |
paymentType | POST /v1/simulations/inbound-payments | Fps, Chaps, Swift , Sepa (case-insensitive) |
status (inbound) | GET /v1/inbound-payments filter and field | Processing, Received, Returning, Returned, Rejected, Cancelled |
status (FX trade) | GET /v1/fx/trades filter and field | Booked, AwaitingSettlement, Settled, Failed, Cancelled |
status (internal payment) | GET /v1/internal-payments | Completed, Created, Failed |
transactionType, sourceType | On a transaction | Open sets. Values seen include PaymentInAllocated, OutboundPaymentInstructed and InboundPayment, OutboundPayment. Treat unrecognised values as ones you do not handle, not as errors. |
The API Reference carries these enumerations in the schema as well.