Get On Ramp transaction status

Get the status of an on ramp transaction.

POST

/

public

/

v1

/

query

/

get_onramp_transaction_status

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

organizationId · string · required

Unique identifier for a given organization.

transactionId · string · required

The unique identifier for the fiat on ramp transaction.

refresh · boolean

Optional flag to specify if the transaction status should be refreshed from the fiat on ramp provider. Default = false.

Response

A successful response returns the following fields:

transactionStatus · string · required

The status of the fiat on ramp transaction.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_onramp_transaction_status \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "transactionId": "<string>",
    "refresh": "<boolean>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getOnRampTransactionStatus({
  organizationId: "<string> (Unique identifier for a given organization.)",
  transactionId: "<string> (The unique identifier for the fiat on ramp transaction.)",
  refresh: true // Optional flag to specify if the transaction status should be refreshed from the fiat on ramp provider. Default = false.
});

200

{
  "transactionStatus": "<string>"
}