API Documentation

Close cash account

post
https://apim.demo01.my.fivedegrees.cloud/sbx/cash-accounts//close

API endpoint to close a cash account

Path Params
string
required

The account identification

Body Params

The account details filters

string | null

The payment description (free text). This is only used internally and can be seen in the movement.

string | null

The payment description (free text). This is the description that will be used in the payment message if generated.

string
required
length ≥ 1

The payment source of the payment. In the reference data endpoint 'payment-sources' a user can get the
full list of available values.

string
required
length ≥ 1

The account number (internal or external depending on the "isExternal" value) where the payment will be sent to.

boolean
required

Set to true if the payment is external and a payment bucket item should be created which results in an outgoing payment messages.
Default is false.

boolean | null

If set to true, the nominated account validation that is set on the product will be bypassed. Default is false.

string | null

The BIC of the counter party for external payments.

string | null

Counterparty BankCode if an external payment.

debtor
object
creditor
object
string | null

MessageType should only be used when a payment should resulte in an payment message.
A Pacs008 message will be produced by default if payment source is SEPA and messageType is not provided.
MT messages can only be used with SWIFT payment source. In the reference data endpoint 'message-types' a
user can get the full list of available values.

string | null

The EndToEndId which will be used in the process.

accountWithInstitution
object
boolean
required

Set to true if the payment perform payments and close accounts, omitting any fees that were defined in fee schemes.
Default is false.

int32 | null

The id of the payment subtype, if applicable.The availability of sub-types depends on the client configuration.

string | null

The name of the payment subtype, if applicable.The availability of sub-types depends on the client configuration.

Headers
string
required
Defaults to v1

API versioning

uuid
required
Defaults to f2dfb2cd-49e4-4e2a-b6a1-bbf1c778feeb

Correlates HTTP requests between a client and server

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
202

Accepted

500

Internal Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json

Updated 3 months ago

Did this page help you?