API Documentation

Create incoming payment bucket

post
https://apim.demo01.my.fivedegrees.cloud/sbx/account-payment-buckets/

API endpoint to create an incoming bucket with payments

Body Params

The create incoming payment bucket request dto.

uuid | null

The bucket id. If not provided, the bucket id is generated by the system.

string | null

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

string
required
length ≥ 1

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

string | null

The external reference.

string | null

The receiver address

payments
array of objects
required

List of payments to be processed in this bucket

payments*
Headers
string
required
Defaults to v1

API versioning

uuid
required
Defaults to 69df58db-1f48-4674-baec-34632aee242d

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
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?