Skip to content
/
Ramp retrieval

Ramp retrieval

Request

Enables retrieval of detailed information about a specific order using its unique identifier.

Security
HMACAuth
Path
ramp_idstring, <= 100 charactersrequired

The ramp ID to fetch.

Example:b7f1ffbb2f1bd7a5e2ba152b4049d234
curl -i -X GET \
  https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/ramps/b7f1ffbb2f1bd7a5e2ba152b4049d234 \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful ramp response

Bodyapplication/json
One of:
idstringrequired

The ramp ID.

Example:"4002"
subPartnerIdstringrequired

Your defined ID for associating an order with. You may use this to differentiate between your customers.

Example:"2125"
identityReferencestring, [ 1 .. 255 ] characters(Identity Reference)^[A-Za-z0-9-]+$required

A unique customer identifier provided by the partner. This field is required and must be unique for each customer.

Important: You must consistently reuse the same identityReference for repeat interactions with the same customer, allowing Banxa to reliably recognize and associate their identity across multiple transactions.

Format Requirements:

  • Only ASCII letters (a-z, A-Z), digits (0-9), and hyphens (-) are allowed
  • Must be between 1 and 255 characters
  • Case-sensitive

Best Practices:

  • Use a consistent format across your system
  • Consider using a prefix to identify your organization (e.g., 'partner-customer-123')
  • Do not include personally identifiable information (PII) in the reference
  • Store the mapping between your internal customer ID and this reference securely
Example:"c-13344"
statusstringrequired
StatusDescription
INITIALIZEDThe request has been accepted and is queued for processing.
AWAITING_FUNDSThe order is ready; awaiting receipt of funds at the specified wallet address.
FUNDS_RECEIVEDFunds have been successfully received at the destination wallet address.
UNDER_REVIEWThe order is undergoing compliance and security review.
COMPLETEDThe order is finalized: funds have been secured and fiat disbursed to the customer's method.
CANCELLEDThe order has been cancelled and will not proceed.
REFUNDEDThe amount has been returned to the customer's wallet address.
Enum:"INITIALIZED""AWAITING_FUNDS""PAYMENT_SUBMITTED""FUNDS_RECEIVED""UNDER_REVIEW""CANCELLED""REFUNDED""COMPLETED"
Example:"INITIALIZED"
sourceobjectrequired
targetobjectrequired
sourceDepositInstructionsobjectrequired
receiptobjectrequired
createdAtstring, (date-time)required

The UTC date time of creation.

Example:"2023-05-05T19:53:08.320Z"
completedAtstring or null, (date-time)required

The UTC date time of the completion. Null if not yet completed.

Example:"2023-06-05T19:53:08.320Z"
Response
{
  "id": "4002",
  "subPartnerId": "2125",
  "identityReference": "c-13344",
  "status": "INITIALIZED",
  "source": {
    "crypto": { … },
    "amount": "105"
  },
  "target": {
    "fiat": { … },
    "amount": "100.5"
  },
  "sourceDepositInstructions": {
    "walletAddress": "0x46B2E9701FE4F6C0A23533D196DbBE7EfEeDea4F",
    "walletAddressMemo": "1684"
  },
  "receipt": {
    "sourceTransactionHash": "0x637f3f8c7b15a83657901ca9f9e0134f0b7dad09e09fbac8a637d026343f586e",
    "gatewayFee": "1.95",
    "networkFee": "1.95",
    "sourceAmount": "100",
    "targetAmount": "100"
  },
  "createdAt": "2023-05-05T19:53:08.320Z",
  "completedAt": "2023-06-05T19:53:08.320Z"
}
© Banxa 2026