RHrhinestonewtf
Onramp

Get an onramp order

Changed on

Accepts any id the caller holds: the order id, the provider’s order id (e.g. the orderId of the legacy onramp-order webhook), the orderId returned when the checkout was started (when retries share it, the newest order), or the externalCustomerId signed into the checkout (<account>:<reference>). 404 until the provider first reports the order. A customer bearer reads that customer’s orders and every order on its bound account.

get/onramp/orders/{id}

Request

Path parameters

idstring required

Order id, provider order id, checkout reference, or <account>:<reference>

Headers

x-api-keystring

Integrator API key: the project’s orders

authorizationstring

Customer bearer from POST /compliance/sessions, or a project-scoped platform bearer where the route permits tenant access

Example:Bearer eyJhbGciOi...

Response

The order

idstring uuid required
provider'noah' | 'swapped' required
kind'fiat' | 'exchange' required
status'pending' | 'processing' | 'completed' | 'failed' | 'refunded' required
terminalboolean required

No stage will change again

accountstring required

Ethereum address (0x followed by 40 hex characters)

deliveryAddressstring nullable required

Ethereum address (0x followed by 40 hex characters)

deliveryChainstring nullable required

CAIP-2 chain of the delivery, e.g. eip155:8453

providerStatusstring required

The provider’s own status; informational

createdAtstring date-time required

When the provider says the order began

updatedAtstring date-time required

Example response

{
  "account": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "deliveryAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
}

Changes

  • aa1767d704faRevision changes
    • warning

      added the new PROVIDER_FORBIDDEN enum value to the response property for the response status

    • warning

      added the new PROVIDER_FORBIDDEN enum value to the response property for the response status

    • warning

      added the new PROVIDER_FORBIDDEN enum value to the response property for the response status

    • warning

      added the new PROVIDER_FORBIDDEN enum value to the response property for the response status

    • warning

      added the new PROVIDER_REJECTED enum value to the response property for the response status

    • warning

      added the new PROVIDER_REJECTED enum value to the response property for the response status

    • warning

      added the new PROVIDER_REJECTED enum value to the response property for the response status

    • warning

      added the new PROVIDER_REJECTED enum value to the response property for the response status

    • warning

      added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new READ_ONLY_SESSION enum value to the response property for the response status

    • warning

      added the new READ_ONLY_SESSION enum value to the response property for the response status

    • warning

      added the new READ_ONLY_SESSION enum value to the response property for the response status

    • warning

      added the new READ_ONLY_SESSION enum value to the response property for the response status

    • info

      the endpoint scheme security complianceSessionBearer was added to the API

    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 8b74181ef9e2Revision changes
    • breaking

      added the pattern ^[A-Za-z0-9._:-]{1,128}$ to the path request parameter id

    • info

      for the path request parameter id, the format was generalized from uuid to no format

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status