curl --request POST \
--url https://api.turnkey.com/public/v1/submit/init_fiat_on_ramp \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"onrampProvider": "<FIAT_ON_RAMP_PROVIDER_COINBASE>",
"walletAddress": "<string>",
"network": "<FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN>",
"cryptoCurrencyCode": "<FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC>",
"fiatCurrencyCode": "<FIAT_ON_RAMP_CURRENCY_AUD>",
"fiatCurrencyAmount": "<string>",
"paymentMethod": "<FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"sandboxMode": "<boolean>"
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"initFiatOnRampIntent": {
"onrampProvider": "<FIAT_ON_RAMP_PROVIDER_COINBASE>",
"walletAddress": "<string>",
"network": "<FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN>",
"cryptoCurrencyCode": "<FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC>",
"fiatCurrencyCode": "<FIAT_ON_RAMP_CURRENCY_AUD>",
"fiatCurrencyAmount": "<string>",
"paymentMethod": "<FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"sandboxMode": "<boolean>"
}
},
"result": {
"initFiatOnRampResult": {
"onRampUrl": "<string>",
"onRampTransactionId": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
Initiate a fiat on ramp flow.
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/init_fiat_on_ramp \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"onrampProvider": "<FIAT_ON_RAMP_PROVIDER_COINBASE>",
"walletAddress": "<string>",
"network": "<FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN>",
"cryptoCurrencyCode": "<FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC>",
"fiatCurrencyCode": "<FIAT_ON_RAMP_CURRENCY_AUD>",
"fiatCurrencyAmount": "<string>",
"paymentMethod": "<FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"sandboxMode": "<boolean>"
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"initFiatOnRampIntent": {
"onrampProvider": "<FIAT_ON_RAMP_PROVIDER_COINBASE>",
"walletAddress": "<string>",
"network": "<FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN>",
"cryptoCurrencyCode": "<FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC>",
"fiatCurrencyCode": "<FIAT_ON_RAMP_CURRENCY_AUD>",
"fiatCurrencyAmount": "<string>",
"paymentMethod": "<FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"sandboxMode": "<boolean>"
}
},
"result": {
"initFiatOnRampResult": {
"onRampUrl": "<string>",
"onRampTransactionId": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
ACTIVITY_TYPE_INIT_FIAT_ON_RAMP
The parameters object containing the specific intent data for this activity.
Show details
FIAT_ON_RAMP_PROVIDER_COINBASE
, FIAT_ON_RAMP_PROVIDER_MOONPAY
FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN
, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM
, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA
, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE
FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC
, FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH
, FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL
, FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC
FIAT_ON_RAMP_CURRENCY_AUD
, FIAT_ON_RAMP_CURRENCY_BGN
, FIAT_ON_RAMP_CURRENCY_BRL
, FIAT_ON_RAMP_CURRENCY_CAD
, FIAT_ON_RAMP_CURRENCY_CHF
, FIAT_ON_RAMP_CURRENCY_COP
, FIAT_ON_RAMP_CURRENCY_CZK
, FIAT_ON_RAMP_CURRENCY_DKK
, FIAT_ON_RAMP_CURRENCY_DOP
, FIAT_ON_RAMP_CURRENCY_EGP
, FIAT_ON_RAMP_CURRENCY_EUR
, FIAT_ON_RAMP_CURRENCY_GBP
, FIAT_ON_RAMP_CURRENCY_HKD
, FIAT_ON_RAMP_CURRENCY_IDR
, FIAT_ON_RAMP_CURRENCY_ILS
, FIAT_ON_RAMP_CURRENCY_JOD
, FIAT_ON_RAMP_CURRENCY_KES
, FIAT_ON_RAMP_CURRENCY_KWD
, FIAT_ON_RAMP_CURRENCY_LKR
, FIAT_ON_RAMP_CURRENCY_MXN
, FIAT_ON_RAMP_CURRENCY_NGN
, FIAT_ON_RAMP_CURRENCY_NOK
, FIAT_ON_RAMP_CURRENCY_NZD
, FIAT_ON_RAMP_CURRENCY_OMR
, FIAT_ON_RAMP_CURRENCY_PEN
, FIAT_ON_RAMP_CURRENCY_PLN
, FIAT_ON_RAMP_CURRENCY_RON
, FIAT_ON_RAMP_CURRENCY_SEK
, FIAT_ON_RAMP_CURRENCY_THB
, FIAT_ON_RAMP_CURRENCY_TRY
, FIAT_ON_RAMP_CURRENCY_TWD
, FIAT_ON_RAMP_CURRENCY_USD
, FIAT_ON_RAMP_CURRENCY_VND
, FIAT_ON_RAMP_CURRENCY_ZAR
FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD
, FIAT_ON_RAMP_PAYMENT_METHOD_APPLE_PAY
, FIAT_ON_RAMP_PAYMENT_METHOD_GBP_BANK_TRANSFER
, FIAT_ON_RAMP_PAYMENT_METHOD_GBP_OPEN_BANKING_PAYMENT
, FIAT_ON_RAMP_PAYMENT_METHOD_GOOGLE_PAY
, FIAT_ON_RAMP_PAYMENT_METHOD_SEPA_BANK_TRANSFER
, FIAT_ON_RAMP_PAYMENT_METHOD_PIX_INSTANT_PAYMENT
, FIAT_ON_RAMP_PAYMENT_METHOD_PAYPAL
, FIAT_ON_RAMP_PAYMENT_METHOD_VENMO
, FIAT_ON_RAMP_PAYMENT_METHOD_MOONPAY_BALANCE
, FIAT_ON_RAMP_PAYMENT_METHOD_CRYPTO_ACCOUNT
, FIAT_ON_RAMP_PAYMENT_METHOD_FIAT_WALLET
, FIAT_ON_RAMP_PAYMENT_METHOD_ACH_BANK_ACCOUNT
Show activity details
Show intent details
Show initFiatOnRampIntent details
FIAT_ON_RAMP_PROVIDER_COINBASE
, FIAT_ON_RAMP_PROVIDER_MOONPAY
FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN
, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM
, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA
, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE
FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC
, FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH
, FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL
, FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC
FIAT_ON_RAMP_CURRENCY_AUD
, FIAT_ON_RAMP_CURRENCY_BGN
, FIAT_ON_RAMP_CURRENCY_BRL
, FIAT_ON_RAMP_CURRENCY_CAD
, FIAT_ON_RAMP_CURRENCY_CHF
, FIAT_ON_RAMP_CURRENCY_COP
, FIAT_ON_RAMP_CURRENCY_CZK
, FIAT_ON_RAMP_CURRENCY_DKK
, FIAT_ON_RAMP_CURRENCY_DOP
, FIAT_ON_RAMP_CURRENCY_EGP
, FIAT_ON_RAMP_CURRENCY_EUR
, FIAT_ON_RAMP_CURRENCY_GBP
, FIAT_ON_RAMP_CURRENCY_HKD
, FIAT_ON_RAMP_CURRENCY_IDR
, FIAT_ON_RAMP_CURRENCY_ILS
, FIAT_ON_RAMP_CURRENCY_JOD
, FIAT_ON_RAMP_CURRENCY_KES
, FIAT_ON_RAMP_CURRENCY_KWD
, FIAT_ON_RAMP_CURRENCY_LKR
, FIAT_ON_RAMP_CURRENCY_MXN
, FIAT_ON_RAMP_CURRENCY_NGN
, FIAT_ON_RAMP_CURRENCY_NOK
, FIAT_ON_RAMP_CURRENCY_NZD
, FIAT_ON_RAMP_CURRENCY_OMR
, FIAT_ON_RAMP_CURRENCY_PEN
, FIAT_ON_RAMP_CURRENCY_PLN
, FIAT_ON_RAMP_CURRENCY_RON
, FIAT_ON_RAMP_CURRENCY_SEK
, FIAT_ON_RAMP_CURRENCY_THB
, FIAT_ON_RAMP_CURRENCY_TRY
, FIAT_ON_RAMP_CURRENCY_TWD
, FIAT_ON_RAMP_CURRENCY_USD
, FIAT_ON_RAMP_CURRENCY_VND
, FIAT_ON_RAMP_CURRENCY_ZAR
FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD
, FIAT_ON_RAMP_PAYMENT_METHOD_APPLE_PAY
, FIAT_ON_RAMP_PAYMENT_METHOD_GBP_BANK_TRANSFER
, FIAT_ON_RAMP_PAYMENT_METHOD_GBP_OPEN_BANKING_PAYMENT
, FIAT_ON_RAMP_PAYMENT_METHOD_GOOGLE_PAY
, FIAT_ON_RAMP_PAYMENT_METHOD_SEPA_BANK_TRANSFER
, FIAT_ON_RAMP_PAYMENT_METHOD_PIX_INSTANT_PAYMENT
, FIAT_ON_RAMP_PAYMENT_METHOD_PAYPAL
, FIAT_ON_RAMP_PAYMENT_METHOD_VENMO
, FIAT_ON_RAMP_PAYMENT_METHOD_MOONPAY_BALANCE
, FIAT_ON_RAMP_PAYMENT_METHOD_CRYPTO_ACCOUNT
, FIAT_ON_RAMP_PAYMENT_METHOD_FIAT_WALLET
, FIAT_ON_RAMP_PAYMENT_METHOD_ACH_BANK_ACCOUNT
Show result details
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/init_fiat_on_ramp \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"onrampProvider": "<FIAT_ON_RAMP_PROVIDER_COINBASE>",
"walletAddress": "<string>",
"network": "<FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN>",
"cryptoCurrencyCode": "<FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC>",
"fiatCurrencyCode": "<FIAT_ON_RAMP_CURRENCY_AUD>",
"fiatCurrencyAmount": "<string>",
"paymentMethod": "<FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"sandboxMode": "<boolean>"
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_INIT_FIAT_ON_RAMP",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"initFiatOnRampIntent": {
"onrampProvider": "<FIAT_ON_RAMP_PROVIDER_COINBASE>",
"walletAddress": "<string>",
"network": "<FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN>",
"cryptoCurrencyCode": "<FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC>",
"fiatCurrencyCode": "<FIAT_ON_RAMP_CURRENCY_AUD>",
"fiatCurrencyAmount": "<string>",
"paymentMethod": "<FIAT_ON_RAMP_PAYMENT_METHOD_CREDIT_DEBIT_CARD>",
"countryCode": "<string>",
"countrySubdivisionCode": "<string>",
"sandboxMode": "<boolean>"
}
},
"result": {
"initFiatOnRampResult": {
"onRampUrl": "<string>",
"onRampTransactionId": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
Was this page helpful?