Skip to main content
GET
/
api
/
v2
/
backoffice
/
ramps
cURL
curl --request GET \
  --url https://sandbox.killb.app/api/v2/backoffice/ramps
{
  "totalPages": 123,
  "currentPage": 123,
  "totalItems": 123,
  "ramps": [
    {
      "id": "<string>",
      "customerId": "<string>",
      "userId": "<string>",
      "providerId": "<string>",
      "status": "<string>",
      "type": "<string>",
      "cashInMethod": "<string>",
      "cashOutMethod": "<string>",
      "originAccountId": "<string>",
      "destinationAccounts": [
        "<string>"
      ],
      "quotationId": "<string>",
      "quotation": {},
      "fromCurrency": "<string>",
      "toCurrency": "<string>",
      "fromAmount": 123,
      "toAmount": 123,
      "baseAmount": 123,
      "quoteAmount": 123,
      "baseCurrency": "<string>",
      "quoteCurrency": "<string>",
      "isPreFunded": true,
      "origin": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

​
status
string

Filter by ramp status. Can be a single status string or an array of status strings

​
type
string

Filter by ramp type. Can be a single type string or an array of type strings. Valid values: ON, OFF

​
id
string

Filter by ramp ID. Can be a single ID string or an array of ID strings

​
customerId
string

Filter by customer ID

​
limit
number
default:50

Number of items per page

​
page
number
default:1

Page number

Response

​
totalPages
number
required
​
currentPage
number
required
​
totalItems
number
required
​
ramps
object[]
required