v1

latestOpenAPI 3.1.02026-07-24320172.9 KB

Retrieve Ramp

get/api/ramp/v1/swaporder

Query parameters

taxIdstring

ield that uniquely identifies the individual or country. Only numbers accepted, all number should be sent, including leading zeros when applicable.

namestring

Holder's name

emailstring

Holder's email

referenceIdstring

Unique identification for transaction

withdrawalKeystring

beginDatestring date

Start date of the searched ramp

endDatestring date

Final date of the searched ramp

pageNumberinteger

As a paginated endpoint, It's possible to define which page to get information. Page number must start with at least 1.

pageSizeinteger

As a paginated endpoint, It's possible to select how many responses the page can have

statusstring

Filter by swap order status

Headers

Authorizationstring required

The personal authentication token obtained by each user from the token authentication endpoint

Response

200

idstring

statusstring

accountIdinteger

{"stackTrail":"paths:/api/ramp/v1/swaporder:get:responses:200:content:application/json:schema:items:properties:externalId","oasType":"schema","type":"unknown"}

clientIdstring

referenceIdstring

namestring

taxIdstring

taxIdCountryinteger

partitionKeystring

{"stackTrail":"paths:/api/ramp/v1/swaporder:get:responses:200:content:application/json:schema:items:properties:description","oasType":"schema","type":"unknown"}

documentTypeinteger

Example response

[
  {
    "id": "733c4892-a7fc-442a-9303-5938308520f8",
    "status": "SwapOrderCreated",
    "accountId": 3000,
    "clientId": "58b1d2e0-f4a7-4d07-ba16-bffca6aa861f",
    "referenceId": "139TG231113553254879149FAA",
    "name": "Teste SwapOrder MATIC",
    "taxId": "44115144432",
    "taxIdCountry": 76,
    "from": {
      "accountId": 3000,
      "amount": 100,
      "currency": "BRL"
    },
    "to": {
      "accountId": 3001,
      "amount": 100,
      "currency": "BRZ"
    },
    "statusHistory": [
      {
        "status": "SwapOrderCreated",
        "createdAt": "2025-01-02T18:17:33.9833095"
      }
    ],
    "withdrawalInformation": {
      "accountKey": "0x168517003AA85bD3B8816Ce0a4Df96f41371be46"
    },
    "partitionKey": "SwapOrder",
    "documentType": 18
  }
]