Settlement chain

See Settlement for what this does. This endpoint reads and sets the one chain your account settles to.

Endpoint

GET https://merchant.minisend.xyz/api/v1/settlement
PUT https://merchant.minisend.xyz/api/v1/settlement

Authorization: Bearer wsk_live_your_key_here

GET needs wallets:read. PUT needs wallets:write.

Reading your setting

curl https://merchant.minisend.xyz/api/v1/settlement \
  -H "Authorization: Bearer wsk_live_your_key_here"

{
  "settlement": {
    "chain": "MATIC",
    "chains": ["BASE", "MATIC", "ARB", "OP", "ETH", "AVAX", "ARC"],
    "available": true,
    "applies_to": "new_deposits"
  }
}

string

Your settlement chain, or null if you haven’t set one (settlement is off).

array

required

The chains your plan can settle to.

boolean

required

Whether settlement can be turned on for your account at all right now. false means chain can’t be changed yet — a PUT is refused with 409 until this is true.

string

required

Always "new_deposits". Changing chain never redirects a settlement already under way.

Changing your setting

string

required

One of the values in chains, or null to switch settlement off.

curl -X PUT https://merchant.minisend.xyz/api/v1/settlement \
  -H "Authorization: Bearer wsk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"chain": "MATIC"}'

Returns the same shape as the GET above, under settlement. Send {"chain": null} to switch it off.

The free plan settles on Base only.

Errors

Status	Meaning
`400`	`chain` missing, not a string, or not one of `chains`
`401`	Missing or invalid API key
`409`	Settlement isn’t available on your account yet
`503`	Could not read or write your setting right now. Retry

Overview

Endpoints

Off-ramp endpoints

Onramp endpoints

Wallet API endpoints

Settlement chain

Endpoint

Reading your setting

Changing your setting

Errors

​Endpoint

​Reading your setting

​Changing your setting

​Errors

Endpoint

Reading your setting

Changing your setting

Errors