JSAPI responses

Common structure of responses

Successful response:

{
    "success": true,
    "data": {
        <field_name>: <field_value>,
        ...
    }
}

Response with an out-of-form error:

{
    "success": false,
    "errors": {
        <error_key>: true,
    }
}

Response with an in-form error:

{
    "success": false,
    "errors": {
        "form": {
            <field_name>: {
                <error_key>: true
            }
        }
    }
}

ENDPOINTS

user_change_password

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	new_password	passwords_mismatch	The new password does not match the confirmation
+	new_password	required	Required field
+	old_password	invalid_old_password	Current password is invalid
+	old_password	required	Required field
+	new_password_repeat	required	Required field

user_change_avatar

Successful response:

...
"data": {
    "user": {
        <customer_fields>: <values>,
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	avatar	required	Required field
+	avatar	invalid_base65_data	Invalid base64 data
+	avatar	no_file_provided	No file provided
+	avatar	invalid_image_data	Invalid image data

user_get_avatar

Successful response:

...
"data": {
    "avatar": {
        <avatar_fields>: <values>,
        ...
    }
}

Possible errors:

form?	field_name	error_message	description
-	-	customer_not_found	Customer not found

user_email_confirm

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	email_confirm_code	required	Required field
+	email_confirm_code	already_confirmed	Email already confirmed
+	email_confirm_code	invalid_data	Invalid email_confirm_code

user_phone_confirm

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	phone_confirm_code	required	Required field
+	phone_confirm_code	already_confirmed	Phone already confirmed
+	phone_confirm_code	invalid_data	Invalid phone_confirm_code

send_email_confirm_code

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	time_limits	Timeout exceeded
-	-	email_confirm_date	Email confirm date already exists

send_phone_confirm_code

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	time_limits	Timeout exceeded
-	-	phone_confirm_date	Phone confirm date already exists

user_verify_identity

Successful response:

...
"data": {
    "user": {
        <field>: <value>,
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	first_name	required	Required field
+	last_name	required	Required field
+	phone	required	Required field
+	phone	invalid	Invalid phone format
+	country	required	Required field
+	city	required	Required field
+	zip_code	required	Required field
+	address_line1	required	Required field
+	address_line2	required	Required field
+	birthday	required	Required field

user_upload_document

Successful response:

...
"data": {
    "user": {
        <field>: <value>,
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	document	required	Required field
+	document	invalid_data	No file provided
+	filename	required	Required field
+	content_type	required	Required field
+	document_type	required	Required field
+	document_subtype	required	Required field

user_logout

Successful response:

...
"data": {
    "auth": false
},

user_info

Successful response:

...
"data": {
    "user": {
        <field>: <value>,
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found

user_documents

Successful response:

...
"data": {
    "documents": {
        <field>: <value>,
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found

user_invoices

Successful response:

...
"data": {
    "invoices": {
        <field>: <value>,
        ...
    },
    "invoices_count": {
        <field>: <value>,
        ...
    },
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found

transaction_history

Successful response:

...
"data": {
    "transactions": {
        <field>: <value>,
        ...
    },
    "transactions_count": {
        <field>: <value>,
        ...
    },
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found

top_up

Successful response:

...
"data": {
    "cash_url": <str>,
    "key": <str>,
    "cash_js_url": <str>,
    "limits": {...},
    "fees": {...},
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	personal_data_not_confirmed	Personal data is not confirmed
-	-	system_error	Currency data were not provided

send

Successful response:

...
"data": {
    "uuid": <str>,
    "need_confirm": <bool>,
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	personal_data_not_confirmed	Personal data is not confirmed
-	-	not_enough_money	Not enough money
-	-	system_error	Duplicate transaction in process / Insufficient funds / Process transaction failed
+	amount	required	Required field
+	currency	required	Required field
+	customer_purse	required	Required field
+	customer_purse	invalid	Invalid customer purse

exchange

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	personal_data_not_confirmed	Personal data is not confirmed
-	-	not_enough_money	Not enough money
-	-	system_error	to_currency/from_currency/from_amount were provided
+	from_amount	required	Required field
+	from_currency	required	Required field
+	to_currency	required	Required field

withdraw

Successful response:

...
"data": {
    "cash_url": ...,
    "key": ...,
    "cash_js_url": ...,
    "limits": ...,
    "fees": ...,
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	personal_data_not_confirmed	Personal data is not confirmed
-	-	system_error	Currency data were not provided

withdraw_otp_confirm

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	transaction_undefined	Transaction is undefined
-	-	insufficient_funds	Insufficient funds
-	-	transaction_declined	Transaction has been declined
+	uuid	required	Required field
+	otp_code	required	Required field
-	-	otp_invalid	Invalid otp code

remove_customer_binding

Successful response:

...
"data": {
    "message": "Successfully removed customer binding"
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	mapped_accounts_not_found	Mapped accounts are not found
-	-	email_not_found	Customer with this email is not found
+	chosen_email	required	Required field

purchase

Successful response:

...
"data": {
    "need_confirm": ...
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	personal_data_not_confirmed	Personal data is not confirmed
-	-	transaction_is_undefined	Transaction is undefined
-	-	system_error	Purse is undefined / Duplicate transaction in process / Insufficient funds / Process transaction failed
-	-	not_enough_money	Not enough money
+	uuid	required	Required field
+	uuid	invalid	Invalid uuid
+	currency	required	Required field

transaction_confirm

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	transaction_is_undefined	Transaction is undefined
-	-	personal_data_not_confirmed	Personal data is not confirmed
+	uuid	required	Required field
+	uuid	invalid	Invalid uuid
+	uuid	transaction_already_confirmed	Transaction is already confirmed
+	confirm_code	required	Required field
-	-	system_error	Duplicate transaction in process / Insufficient funds / Process transaction failed

send_confirmation_code

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	time_limit_reached	Time limit has been reached
-	-	personal_data_not_confirmed	Personal data is not confirmed
+	uuid	required	Required field
+	uuid	invalid	Invalid uuid
+	type	required	Required field
+	confirmation_code	required	Required field

create_purse

Successful response:

...
"data": {
    "purse": {...},
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	system_error	Currency were not provided
-	-	personal_data_not_confirmed	Personal data is not confirmed

purses

Successful response:

...
"data": {
    "purses": [
        {
            "id": ...,
            "balance": ...,
            "currency": ...,
        },
        ...
    ]
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found

private_ping

Successful response:

...
"data": {
    "pong": true
}

partner_purchase

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	currency	required	Required field
+	site_id	required	Required field
+	amount	required	Required field
-	-	insufficient_funds	Insufficient funds
-	-	not_found_partner_<site_id>	Partner is not found
-	-	not_found_partner_program_<site_id_name>	Partner program is not found
-	-	not_found_your_account_for_partner_<site_id_name>	No account is found for the partner
-	-	receiving_purse_not_found	Receiving purse is not found
-	-	system_error	Duplicate transaction in process / Insufficient funds / Process transaction failed

rates

Successful response:

...
"data": {
    "currency": ...,
    "rates": {
        ...
    }
}

commissions

Successful response:

...
"data": {
    "commissions": {
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	currency	required	Required field
+	type	required	Required field
+	amount	required	Required field
+	payment_group_id	required	Required field

transaction_info

Successful response:

...
"data": {
    "transaction": {
        ...
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	uuid	invalid	Invalid uuid
+	uuid	required	Required field

get_terms

Successful response:

...
"data": {
    "term": {
        "term_hash": ...,
        "text": ...,
    }
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	term_does_not_exist	Term doesn't exist
+	term_hash	required	Required field

update_customer_term

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	term_does_not_exist	Term doesn't exist
+	term_hash	required	Required field

send_support_email

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	token_expired	Token expired
+	text	required	Required field

confirm_register

Successful response:

...
"data": {
    "token": ...,
}

Possible errors:

HTTPBadRequest

form?	field_name	error_key	description
+	-	reg_id_not_found	Reg_id is not found
+	-	customer_not_found	Customer not found

activate_account_by_email

Successful response:

...
"data": {
    "access": {
        "access_token": ...,
        "access_token_exp": ...,
        "refresh_token": ...,
    }
}

Possible errors:

form?	field_name	error_key	description
+	token ?	expired	Expired token
+	token ?	already_activated	Customer already activated

restore_password

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
+	email	required	Required field
+	email	invalid	Invalid email
+	email	account_deactivated	Your account has been deactivated. Please contact customer support
-	-	email_already_sent	Email already has been sent

update_password

Successful response:

...
"data": {
    "access": {
        "access_token": ...,
        "access_token_exp": ...,
        "refresh_token": ...,
    }
}

Possible errors:

form?	field_name	error_key	description
+	new_password	required	Required field
+	new_password	invalid	Invalid token
+	new_password_repeat	required	Required field
+	new_password_repeat	passwords_mismatch	Passwords mismatch
-	-	token_expired	Token is expired. Request a new reset email

user_login

Successful response:

...
"data": {
    "auth": true,
    "user": ...,
    "token": ...,
}

...
"data": {
    "need_otp": true,
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	invalid_otp	invalid or timed out otp code
+	email	required	Required field
+	email	invalid	Invalid email
+	email	account_is_disabled	Account is disabled
+	password	required	Required field
+	password	invalid	Invalid password
+	otp_code	required	Required field
+	otp_code	invalid	Invalid or timed out otp code

change_lang

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
+	lang	required	Required field

init_data

Successful response:

...
"data": {
    "COUNTRY_ISO": ...,
    "PHONE_PREFIX": ...,
    "LANG": ...,
    // --- if a customer has been found ↙
    "PARTNER_PROJECTS": ...,
    "DOCUMENT_TYPES": ...,
    "DOCUMENT_SUBTYPES": ...,
    "CURRENCIES": ...,
    "FIAT_CURRENCIES": ...,
    "CRYPTO_CURRENCIES": ...,
    "DEFAULT_CURRENCY": ...,
    "RATES_WIDGET": ...,
    "FEATURE_FLAGS": ...,
    "CryptoCurrencyPaymentGroups": ...,
    "BANK_CARD_PAYMENT_GROUPS": ...,
    "user": ...,
    "LANGS": ...,
    "cash_url": ...,
    "terms": ...,
    "twoFaEnabled": ...,
    "ACCOUNT_TYPE": ...,
    "verified": ...,
}

Possible errors:

HTTPUnauthorized

refresh_token

Successful response:

...
"data": {
    "access": {
        "access_token": ...,
        "access_token_exp": ...,
        "refresh_token": ...,
    }
}

Possible errors:

HTTPForbidden
HTTPUnauthorized

user_create

Successful response:

...
"data": {
    "token": ...
}

Possible errors:

form?	field_name	error_key	description
-	-	already_logged_in	Customer already logged in
+	email	required	Required field
+	email	invalid	Invalid field
+	username	required	Required field
+	password	required	Required field
+	terms_accepted	required	Must be accepted
+	site_id	required	Required field
+	site_login_id	required	Required field
+	user_preset_id	required	Required field

confirm_register

Successful response:

...
"data": {
    "token": ...
}

Possible errors:

form?	field_name	error_key	description
-	-	customer_not_found	Customer not found
-	-	customer_not_found	Reg_id not found

rates_all

Successful response:

...
"data": {
    "rates": {
        "<str>": {
            "title": ...,
            "minor_unit": ...,
            "rate": ...
        },
        ...
    }
}

get_countries_list

Successful response:

...
"data": {
    "countries": [<str>, ...],
    "phone_codes": [{}, {}, ...]
}

get_page

Successful response:

...
"data": {
    "page": <str> ?
}

get_terms_for_landing

Successful response:

...
"data": {
    "term": <str>
}

Possible errors:

form?	field_name	error_key	description
+	lang	required	Required field
+	account_type	required	Required field

get_bound_wallet_accounts

Successful response:

...
"data": {
    "emails": [<str>, <str>, ...],
    "amount": <int>,
    "currency": <str>
}

Possible errors:

form?	field_name	error_key	description
-	-	invalid_uuid	Invalid uuid
-	-	transaction_already_processed	This transaction already processed
+	uuid	required	Required field

activate_account_by_code

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
+	email_confirm_code	invalid	Invalid code
+	email_confirm_code	required	Required field
+	email_confirm_code	expired	code_expired

resend_code

Successful response:

...
"data": {}

Possible errors:

form?	field_name	error_key	description
-	-	email_already_sent	Email already has been sent. Try again later
-	-	token_expired	Token is expired
+	token	invalid	Invalid token
+	token	required	Required field

multi_account_purchase

Successful response:

...
"data": {
    "tr_uuid": <str>
}

Possible errors:

form?	field_name	error_key	description
-	-	login_required	Login is required
-	-	transaction_already_processed	This transaction already processed
-	-	another_currency_required	Needed to select another currency
+	uuid	required	Required field
+	chosen_email	required	Required field