Skip to main content
POST
/
public
/
v1
/
query
/
get_onramp_transaction_status

Authorizations

  • API Key
  • WebAuthn (Passkey)
​
X-Stamp
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 --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>"
}'

{
  "transactionStatus": "<string>"
}