API Documentation

Create single sweep

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

API endpoint to create a single sweep for a cash account

Path Params
string
required

The account identification

Body Params

Request body containing AccountSweep information

string
required
length ≥ 1

The account where the transfer is going to.

double
required

The amount to be transfered.

string
required
length ≥ 1

The currency of the amount. In the reference data endpoint 'currencies' a user can get the full list of available values.

date-time
required

The value date of the transfer, if empty it will get the systemDate.

date-time

The interest date of the transfer, if empty it will get the valueDate.

date-time | null

Clearing Date. Set to valueDate if not provided.

string | null

The reference of the transfer, free text.

string
required
length ≥ 1

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

string
required
length ≥ 1

The payment type of the transfer. In the reference data endpoint 'payment-types' a user can get the full list of available values.

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.
Note: If in the same time paymentSubTypeId and paymentSubTypeName are provided - the value from paymentSubTypeId will be considered.

string | null

The end to end identification of the transfer.

string | null

The sender reference of the transfer.

boolean | null

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

boolean | null

If set to true - any of the fees defined in the linked fee scheme will be omitted. Default is false

boolean | null

If set to true - the sweep will be posted on the destination account even if its status is Frozen or Blocked. Default is false

string | null

Additional description, max 250 characters.

string | null

Internal reference that can be used along with the movement.

Headers
string
required
Defaults to v1

API versioning

uuid
required
Defaults to d5d11cb0-841f-4c86-abf6-9379d2513c5a

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

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?