Skip to main content
GET
/
onramps
List onramp orders
curl --request GET \
  --url http://localhost:4000/v1/onramps \
  --header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:4000/v1/onramps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "http://localhost:4000/v1/onramps"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "status": "success",
  "message": "<string>",
  "data": {
    "onramps": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orderId": "<string>",
        "customerId": "<string>",
        "reference": "<string>",
        "amount": "<string>",
        "sourceCurrency": "<string>",
        "amountToTransfer": "<string>",
        "deposit": {
          "institution": "<string>",
          "accountIdentifier": "<string>",
          "accountName": "<string>",
          "validUntil": "2023-11-07T05:31:56Z"
        },
        "destinationAddress": "<string>",
        "destinationNetwork": "<string>",
        "destinationCurrency": "<string>",
        "refundAccount": {
          "accountName": "<string>",
          "accountIdentifier": "<string>",
          "institution": "<string>"
        },
        "rate": "<string>",
        "status": "<string>",
        "settlementTxHash": "<string>",
        "settledUsdcAmount": "<string>",
        "settledAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key created in the Remitflex Dashboard at dashboard.remitflex.io (rmf_live_... or rmf_test_...). Key management endpoints require a dashboard JWT and are not part of this reference.

Response

200 - application/json

Onramp orders list

​
status
string
Example:

"success"

​
message
string
​
data
object