API Documentation

Change outgoing return payment bucket status

post
https://apim.demo01.my.fivedegrees.cloud/sbx/account-payment-buckets/outgoing-return//change-status

API endpoint to change the outgoing return payment bucket status. Currently only accepts "ReadyForExport", "AcceptedSettlementCompleted" and "Failed" states.

Path Params
uuid
required

Format - uuid. Bucket Id, the Id the external system uses to identify portfolio.

Body Params

The change outgoing return payment bucket status dto.

string
required
length ≥ 1

The status of the bucket. In the reference data endpoint 'payment-bucket-statuses' an user can get the full list of available values.

string | null

Currently only used for the status "Failed". Can be used for example to clarify the failure reason.

Headers
string
required
Defaults to v1

API versioning

uuid
required
Defaults to 9c6efa7c-44e6-43c8-b17f-d28142a450d0

Format - uuid. 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
200

OK

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?