payments.createOnrampSession#a2197cf6 flags:# provider:string crypto_currency:string address:string payment_method:flags.0?string base_currency:flags.1?string base_amount:flags.2?string memo:flags.3?string theme:flags.4?string success_return_url:flags.5?string fail_return_url:flags.6?string crypto_amount:flags.7?string = OnrampSession;
Parameters
| Name | Type | Description |
|---|
| flags |
# |
Bit mask: a field written flags.N?T is present only when bit N is set. |
| provider |
string |
|
| crypto_currency |
string |
|
| address |
string |
Address. |
| payment_method |
flags.0?string |
|
| base_currency |
flags.1?string |
|
| base_amount |
flags.2?string |
|
| memo |
flags.3?string |
|
| theme |
flags.4?string |
|
| success_return_url |
flags.5?string |
|
| fail_return_url |
flags.6?string |
|
| crypto_amount |
flags.7?string |
|
Result
OnrampSession
Possible errors
This method has no errors of its own: it either answers or fails on the shared checks below.
Common to every call
| Code | Type | What it means |
|---|
| 401 |
AUTH_KEY_UNREGISTERED |
The server does not know this session: the key was revoked, expired, or the call was made before authorisation. |
| 401 |
API_ID_INVALID |
This api_id was never issued or has been blocked. Keys come from my.ansible.su. |
| 400 |
CONNECTION_LAYER_INVALID |
The client did not declare a layer, or declared one the server does not know. |
| 420 |
FLOOD_WAIT_X |
Too often. Do not retry for X seconds — the number arrives in the error text. |
| 500 |
INTERNAL |
A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours. |
Related pages
Types used here