Creates a settlement request - Hellgate Cloud Platform

POST

settlements

request

Creates a settlement request

curl --request POST \
  --url https://commerce1.on-hellgate.dev/settlements/request \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 123,
  "currency_code": "<string>",
  "distributions": [
    {
      "amount": 123,
      "commission": 123,
      "currency": "<string>",
      "destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-API-Key

string

header

required

Headers

X-Account-ID

string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

Body

application/json

Body

amount

integer

currency_code

string

distributions

object[]

Show child attributes

string<uuid>

order_id

string

Response

Success

string<uuid>

OverviewManage customer profiles and data

⌘I

Creates a settlement request

curl --request POST \
  --url https://commerce1.on-hellgate.dev/settlements/request \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 123,
  "currency_code": "<string>",
  "distributions": [
    {
      "amount": 123,
      "commission": 123,
      "currency": "<string>",
      "destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}