GET Get Cashier Methods¶
Endpoint¶
GET /cashier/methods?login={login}
Command¶
GetCashierMethods
Authorization¶
Requires SESSION_CUSTOMER.
Description¶
Returns the payment methods that are currently available for a customer-owned trading account.
The server resolves the account group, brand, account currency, and customer country. Cashier then checks enabled brand-level provider configs, loaded payment modules, country/currency filters, amount limits, and customer-level provider overrides.
Customer overrides can explicitly allow or deny a provider/method for one customer. Overrides do not bypass hard checks: the provider module must be loaded, the provider config must be enabled, the brand must match, and the account must belong to the authenticated customer.
Query Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
login |
int | Yes | Customer-owned trading account login |
Request Example¶
GET /cashier/methods?login=2000009
Authorization: Bearer <CUSTOMER_JWT>
Response Fields¶
| Name | Type | Description |
|---|---|---|
rows |
array | Eligible payment methods |
count |
int | Number of rows |
rows[]¶
| Name | Type | Description |
|---|---|---|
provider_config_id |
int | Brand-level provider config id |
provider |
string | Provider code |
method |
string | Provider method marker |
brand |
string | Brand code resolved from account group |
currency |
string | Supported account/payment currency |
country |
string | Country filter from provider config |
payment_mode |
string | Runtime provider mode, for example redirect |
display_name |
string | Provider display name from payment module |
description |
string | Provider description from payment module |
public_key |
string | Public provider key for client-side SDKs |
min_amount |
double | Minimum allowed amount |
max_amount |
double | Maximum allowed amount, 0 means no limit |
sandbox |
int | 1 sandbox config, 0 production config |
sort_index |
int | Sorting priority |
override_id |
int | Customer override id, 0 when no override applied |
override_mode |
int | 0 allow, 1 deny |
Response Example¶
{
"rows": [
{
"provider_config_id": 1,
"provider": "stripe",
"method": "card",
"brand": "ion4",
"currency": "USD",
"country": "",
"payment_mode": "redirect",
"display_name": "Stripe",
"description": "Card payments",
"public_key": "pk_live_xxx",
"min_amount": 10.0,
"max_amount": 5000.0,
"sandbox": 0,
"sort_index": 100,
"override_id": 0,
"override_mode": 0
}
],
"count": 1
}
Errors¶
| HTTP | Error | Description |
|---|---|---|
400 |
INVALID_DATA |
Request validation failed |
400 |
ACCOUNT_NOT_AVAILABLE |
Account does not exist or is disabled |
400 |
GROUP_NOT_AVAILABLE |
Account group does not exist or is disabled |
403 |
PERMISSION_DENIED |
Account does not belong to the customer |
404 |
CUSTOMER_NOT_FOUND |
Customer record was not found |