Skip to main content

Payment provider information

​
id
enum<string>
required

Payment provider ID used around the API as reference.

Available options:
provider_base_ethereum,
provider_base_usdc,
provider_binance_smart_chain_binance_coin,
provider_binance_smart_chain_usdc,
provider_binance_smart_chain_usdt,
provider_bitcoin_bitcoin,
provider_bitcoin_cash_bitcoin_cash,
provider_dogecoin_dogecoin,
provider_ethereum_ethereum,
provider_ethereum_usdc,
provider_ethereum_usdt,
provider_litecoin_litecoin,
provider_polygon_polygon,
provider_polygon_usdc,
provider_polygon_usdc_native,
provider_polygon_usdt,
provider_ripple_ripple,
provider_solana_solana,
provider_solana_usdc,
provider_solana_usdt,
provider_stripe_acss_debit,
provider_stripe_affirm,
provider_stripe_afterpay_clearpay,
provider_stripe_alipay,
provider_stripe_alma,
provider_stripe_amazon_pay,
provider_stripe_au_becs_debit,
provider_stripe_bacs_debit,
provider_stripe_bancontact,
provider_stripe_billie,
provider_stripe_blik,
provider_stripe_boleto,
provider_stripe_card,
provider_stripe_card_present,
provider_stripe_cashapp,
provider_stripe_crypto,
provider_stripe_customer_balance,
provider_stripe_eps,
provider_stripe_fpx,
provider_stripe_giropay,
provider_stripe_grabpay,
provider_stripe_ideal,
provider_stripe_interac_present,
provider_stripe_kakao_pay,
provider_stripe_klarna,
provider_stripe_konbini,
provider_stripe_kr_card,
provider_stripe_link,
provider_stripe_mobilepay,
provider_stripe_multibanco,
provider_stripe_naver_pay,
provider_stripe_nz_bank_account,
provider_stripe_oxxo,
provider_stripe_p24,
provider_stripe_pay_by_bank,
provider_stripe_payco,
provider_stripe_paynow,
provider_stripe_paypal,
provider_stripe_pix,
provider_stripe_promptpay,
provider_stripe_revolut_pay,
provider_stripe_samsung_pay,
provider_stripe_satispay,
provider_stripe_sepa_debit,
provider_stripe_sofort,
provider_stripe_swish,
provider_stripe_twint,
provider_stripe_us_bank_account,
provider_stripe_wechat_pay,
provider_stripe_zip,
provider_tron_tron,
provider_tron_usdt
Examples:

"provider_solana_usdc"

"provider_stripe_card"

​
provider
enum<string>
required

Provider name. Each payment system has a different name (e.g. CRYPTO means that this payment provider is linked to the main crypto payment system).

Available options:
CRYPTO,
STRIPE
Example:

"CRYPTO"

​
network
enum<string>
required

Payment network. For cryptocurrencies it's the blockchain name, for fiat it's the rail (direct card or a regional method).

Available options:
BASE,
BINANCE_SMART_CHAIN,
BITCOIN,
ARK,
BITCOIN_CASH,
DOGECOIN,
ETHEREUM,
LITECOIN,
POLYGON,
RIPPLE,
SOLANA,
TRON,
CARD,
APM
Examples:

"SOLANA"

"CARD"

​
gateway
enum<string>
required

Payment gateway.

Available options:
ETHEREUM,
USDC,
BINANCE_COIN,
USDT,
BITCOIN,
BITCOIN_CASH,
DOGECOIN,
LITECOIN,
POLYGON,
USDC_NATIVE,
RIPPLE,
SOLANA,
ACSS_DEBIT,
AFFIRM,
AFTERPAY_CLEARPAY,
ALIPAY,
ALMA,
AMAZON_PAY,
AU_BECS_DEBIT,
BACS_DEBIT,
BANCONTACT,
BILLIE,
BLIK,
BOLETO,
CARD,
CARD_PRESENT,
CASHAPP,
CRYPTO,
CUSTOMER_BALANCE,
EPS,
FPX,
GIROPAY,
GRABPAY,
IDEAL,
INTERAC_PRESENT,
KAKAO_PAY,
KLARNA,
KONBINI,
KR_CARD,
LINK,
MOBILEPAY,
MULTIBANCO,
NAVER_PAY,
NZ_BANK_ACCOUNT,
OXXO,
P24,
PAY_BY_BANK,
PAYCO,
PAYNOW,
PAYPAL,
PIX,
PROMPTPAY,
REVOLUT_PAY,
SAMSUNG_PAY,
SATISPAY,
SEPA_DEBIT,
SOFORT,
SWISH,
TWINT,
US_BANK_ACCOUNT,
WECHAT_PAY,
ZIP,
TRON
Examples:

"SOLANA"

"CARD"

​
type
enum<string>

Used to identify whether the gateway is a native blockchain asset or a native system method (e.g. USDC on Solana or Klarna on Stripe would equal to additional).

Available options:
native,
additional
Example:

"native"

​
filters
(enum<string> | null)[] | null

Useful filters to search for a provider. evm = Ethereum Virtual Machine, xvm = Any Virtual Machine (Ethereum, Solana, Binance Smart Chain, etc), svm = Solana Virtual Machine, tvm = Tron Virtual Machine, btc = Any BTC-based (Bitcoin, Bitcoin Cash, Dogecoin, Litecoin, etc)

Available options:
evm,
xvm,
svm,
tvm,
btc,
xrp
Example:
["evm", "xvm"]
​
metadata
object

Additional metadata for the provider.

Example:
{
  "decimals": 18,
  "contract_address": "0x0000000000000000000000000000000000000000",
  "detection_min_amount": 0.0001,
  "image_url": "https://example.com/usdc.png",
  "image_url_network": "https://example.com/usdc_network.png"
}