Skip to main content
GET
/
v1
/
ucp
/
settlements
List settlements
curl --request GET \
  --url https://api.getsly.ai/v1/v1/ucp/settlements \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>
Available options:
pending,
processing,
completed,
failed
corridor
enum<string>
Available options:
pix,
spei,
auto
since
string<date-time>
page
integer
default:1
limit
integer
default:50
Required range: x <= 200

Response

200 - application/json

Paginated settlements

data
object[]
required
pagination
object
required