Skip to main content
POST
/
v1
/
ucp
/
settle
Settle a UCP token
curl --request POST \
  --url https://api.getsly.ai/v1/v1/ucp/settle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>",
  "idempotency_key": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "token_id": "<string>",
    "status": "pending",
    "amount": 123,
    "currency": "USD",
    "corridor": "pix",
    "created_at": "2023-11-07T05:31:56Z",
    "tx_hash": "<string>",
    "rail_reference": "<string>",
    "completed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Body

application/json
token
string
required
Minimum string length: 1
idempotency_key
string
Maximum string length: 64

Response

Settlement initiated

data
object
required