Buy Provider Server (1.0)

Download OpenAPI specification:Download

getCapabilities

Responses

200

default

Error sent by the provider

get/capabilities

Response samples

200
default

application/json

{"fiatCurrencyCapabilities": [{"fiat": "eur",
"minAmount": 50,
"maxAmount": 100000
},
{"fiat": "USD",
"minAmount": 50,
"maxAmount": 100000
},
{"fiat": "GBP",
"minAmount": 50,
"maxAmount": 100000
}
],
"countryCapabilities": [{"country": "FR",
"paymentMethods": [{"name": "paypal"
},
{"name": "pix"
},
{"name": "card"
}
]
},
{"country": "US",
"paymentMethods": [{"name": "paypal"
},
{"name": "pix"
},
{"name": "card"
}
]
},
{"country": "GB",
"paymentMethods": [{"name": "paypal"
},
{"name": "pix"
},
{"name": "card"
}
]
}
]
}

getQuote

SecurityApiKeyAuth

Request

query Parameters

from required	string Fiat currency at the ISO-4217 standard. Example: from=EUR
to required	string Crypto currency ID using the LedgerId format. Example: to=bitcoin
payment-method required	string Payment method, valid values : card, googlepay, applepay, paypal, cryptocom, sepa, ach, instantach, fasterpayments, easybank, bank, cashapp, venmo, pix, mobikwik, easypay, astropay, upibanktransfer, sofort, bancontact, giropay, eps, ideal, other, revolut, p2p, interac, payid, spei, imps, gcash, ovo, shopeepay, grabpay, linkaja, maya, pse, dana, qris. Example: payment-method=paypal
amount required	integer Fiat amount to buy. Example: amount=50
country required	string Country of the user at the Alpha-2 standard (ISO3166). Example: country=FR
dest required	string Destination address of the buy. Example: dest=0x000000000000000000000000000000

Responses

200

400

Invalid value for: query parameter from, Invalid value for: query parameter to, Invalid value for: query parameter payment-method, Invalid value for: query parameter amount, Invalid value for: query parameter country, Invalid value for: query parameter dest

default

Error sent by the provider

get/quote

Response samples

200
default

application/json

{"from": "EUR",
"to": "bitcoin",
"fiatAmount": 50,
"cryptoAmount": 0.2
}

Retrieve a redirect URL

Returns the URL of the on-ramp widget, including the specified buy parameters, to which the user will be redirected.

SecurityApiKeyAuth

Request

query Parameters

from required	string Fiat currency at the ISO-4217 standard. Example: from=EUR
to required	string Crypto currency ID using the LedgerId format. Example: to=bitcoin
payment-method required	string Payment method, valid values: card, googlepay, applepay, paypal, cryptocom, sepa, ach, instantach, fasterpayments, easybank, bank, cashapp, venmo, pix, mobikwik, easypay, astropay, upibanktransfer, sofort, bancontact, giropay, eps, ideal, other, revolut, p2p, interac, payid, spei, imps, gcash, ovo, shopeepay, grabpay, linkaja, maya, pse, dana, qris Example: payment-method=paypal
amount required	integer Fiat amount to buy. Example: amount=50
country required	string Country of the user at the Alpha-2 standard (ISO3166). Example: country=FR
dest required	string Destination address of the buy. Example: dest=0x000000000000000000000000000000
ledgerTransactionId required	string Ledger Live transaction ID. Used by Ledger to track transactions and their completion statuses. Example: ledgerTransactionId=9649d677-f201-45b2-8130-0317065743de
deeplinkUrl	string Deeplink URL to Ledger Live. Example: deeplinkUrl=ledgerlive://buy

Responses

200

400

Bad Request

get/buy-redirect

Response samples

application/json

{"rampRedirectUrl": "https://widget.crypto-partner.com?fiatCurrency=GBP&amount=12345&cryptoCurrency=ETH&walletAddress=0x96e2B7Bf479f84e7A0a94f0620290B7D3E08f5EF&countryCode=GB&partnerId=a01798bc-7f0b-14ed-a12b-0e3fac1209ad&externalOrderId=2d1769bc-7aab-92ed-a10b-0232ac12090d&disableFiatAmount=true&disableCryptoCurrency=true&disableWalletAddress=true&disableCountryCode=true&skipWalletAddress=true&partnerRedirectUrl=https%3A%2F%2Fcrypto.partner.com%2Forder%3ForderId%3D2d1769bc-7aab-92ed-a10b-0232ac12090d"
}

getCrypto-currencies

Responses

200

default

Error sent by the provider

get/crypto-currencies

Response samples

200
default

application/json

["bitcoin",
"solana",
"ethereum",
"ethereum/erc20/aave",
"solana/spl/epjfwdd5aufqssqem2qn1xzybapc8g4weggkzwytdt1v"
]