Interface OnRampPaymentAvailability

Describes availability of cryptocurrency purchase through an on-ramp provider.

interface OnRampPaymentAvailability {
    @type: "onRampPaymentAvailability";
    country_code: string;
    is_allowed?: boolean;
    is_purchase_allowed?: boolean;
    methods: OnRampPaymentMethod[];
    state: string;
}

Properties

@type country_code is_allowed? is_purchase_allowed? methods state

Properties

@type

@type: "onRampPaymentAvailability"

country_code

country_code: string

A two-letter ISO 3166-1 alpha-2 country code of the current user's country.

Optional is_allowed

is_allowed?: boolean

True, if the current user can use the provider.

Optional is_purchase_allowed

is_purchase_allowed?: boolean

True, if the current user can purchase through the provider.

methods

methods: OnRampPaymentMethod[]

The list of available payment methods.

state

state: string

Code of the state of the current user; may be empty if unknown.

Settings

Member Visibility

Theme

On This Page

@typecountry_codeis_allowedis_purchase_allowedmethodsstate