Settlement chain

See Settlement for what this does. This endpoint shows and changes the one network your deposits are gathered on.

Endpoint

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

Authorization: Bearer wsk_live_your_key_here

To read it, your key needs wallets:read. To change it, 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 network, or null if you haven’t set one, which means settlement is off.

array

required

The networks you can choose from on your plan.

boolean

required

Whether settlement can be turned on for your account right now. If it’s false, you can’t change chain yet, and a PUT gets a 409 until it’s true.

string

required

Always "new_deposits". Changing chain never redirects a settlement that’s already on its way.

Changing your setting

string

required

One of the networks in chains, or null to turn 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"}'

You get back the same fields as the GET above, under settlement. Send {"chain": null} to turn it off.

On the Free plan, the only settlement network is Base.

Errors

Status	Meaning
`400`	`chain` is missing, or isn’t one of the networks in `chains`
`401`	Your API key is missing or wrong
`409`	Settlement isn’t available on your account yet
`503`	We couldn’t read or save your setting just now. Try again

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