Init fiat on ramp

Initiate a fiat on ramp flow.

POST

/

public

/

v1

/

submit

/

init_fiat_on_ramp

Authorizations

API Key

X-Stamp · string · required

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

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_INIT_FIAT_ON_RAMP

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.onrampProvider

enum<string>

required

Enum options: FIAT_ON_RAMP_PROVIDER_COINBASE, FIAT_ON_RAMP_PROVIDER_MOONPAY

parameters.walletAddress

string

required

Destination wallet address for the buy transaction.

parameters.network

enum<string>

required

Enum options: FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE

parameters.cryptoCurrencyCode

enum<string>

required

Enum options: FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC, FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH, FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL, FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC

parameters.fiatCurrencyCode

enum<string>

Enum options: 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

parameters.fiatCurrencyAmount

string

Specifies a preset fiat amount for the transaction, e.g., ‘100’. Must be greater than ‘20’. If not provided, the user will be prompted to enter an amount.

parameters.paymentMethod

enum<string>

Enum options: 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

parameters.countryCode

string

ISO 3166-1 two-digit country code for Coinbase representing the purchasing user’s country of residence, e.g., US, GB.

parameters.countrySubdivisionCode

string

ISO 3166-2 two-digit country subdivision code for Coinbase representing the purchasing user’s subdivision of residence within their country, e.g. NY. Required if country_code=US.

parameters.sandboxMode

boolean

Optional flag to indicate whether to use the sandbox mode to simulate transactions for the on-ramp provider. Default is false.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.initFiatOnRampIntent

object

required

The initFiatOnRampIntent object

Show initFiatOnRampIntent details

activity.intent.initFiatOnRampIntent.onrampProvider

enum

required

onrampProvider field

Enum options: FIAT_ON_RAMP_PROVIDER_COINBASE, FIAT_ON_RAMP_PROVIDER_MOONPAY

activity.intent.initFiatOnRampIntent.walletAddress

string

required

Destination wallet address for the buy transaction.

activity.intent.initFiatOnRampIntent.network

enum

required

network field

Enum options: FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BITCOIN, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_ETHEREUM, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_SOLANA, FIAT_ON_RAMP_BLOCKCHAIN_NETWORK_BASE

activity.intent.initFiatOnRampIntent.cryptoCurrencyCode

enum

required

cryptoCurrencyCode field

Enum options: FIAT_ON_RAMP_CRYPTO_CURRENCY_BTC, FIAT_ON_RAMP_CRYPTO_CURRENCY_ETH, FIAT_ON_RAMP_CRYPTO_CURRENCY_SOL, FIAT_ON_RAMP_CRYPTO_CURRENCY_USDC

activity.intent.initFiatOnRampIntent.fiatCurrencyCode

enum

fiatCurrencyCode field

Enum options: 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

activity.intent.initFiatOnRampIntent.fiatCurrencyAmount

string

Specifies a preset fiat amount for the transaction, e.g., ‘100’. Must be greater than ‘20’. If not provided, the user will be prompted to enter an amount.

activity.intent.initFiatOnRampIntent.paymentMethod

enum

paymentMethod field

Enum options: 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

activity.intent.initFiatOnRampIntent.countryCode

string

ISO 3166-1 two-digit country code for Coinbase representing the purchasing user’s country of residence, e.g., US, GB.

activity.intent.initFiatOnRampIntent.countrySubdivisionCode

string

ISO 3166-2 two-digit country subdivision code for Coinbase representing the purchasing user’s subdivision of residence within their country, e.g. NY. Required if country_code=US.

activity.intent.initFiatOnRampIntent.sandboxMode

boolean

Optional flag to indicate whether to use the sandbox mode to simulate transactions for the on-ramp provider. Default is false.

activity.result

object

required

The result of the activity

Show result details

activity.result.initFiatOnRampResult

object

required

The initFiatOnRampResult object

Show initFiatOnRampResult details

activity.result.initFiatOnRampResult.onRampUrl

string

required

Unique URL for a given fiat on-ramp flow.

activity.result.initFiatOnRampResult.onRampTransactionId

string

required

Unique identifier used to retrieve transaction statuses for a given fiat on-ramp flow.

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

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>"
    }
}'

200

{
  "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>"
      }
    }
  }
}