payway
Using the methods of payway model merchant can:
- Get a list of available payways and their parameters - method payway.list
- Activate a payway for work with the merchant - method payway.activate
- Deactivate a payway for work with the merchant - method payway.deactivate
endpoint
Queries for the model's methods are sent to endpoint https://api.any.money/.
payway.list
The method returns a list of payways, available for the merchant, their parametersand the list of the payway currencies.
Input method arguments
| Param | Required | Example | Description |
|---|---|---|---|
| - | - | - | - |
Method response data
- active_in_system
- is a payway active in Any.Money system
- active_for_merchant
- is a payway active for a current merchant
- is_public
- can a merchant activate / deactivate a current payway
- payin_allowed
- payway can accept credit payments
- tp
- payway type. Possible options: "sci", "crypto", "cheque", "cash"
- {Currency name in a current payway}, its parameters:
- in_fee - fee representation in the replenishment currency
- add - fixed replenishment fee amount
- max - maximum replenishment fee amount
- method - replenishment fee rounding method
- min - minimum replenishment fee amount
- mult - replenishment fee rate
- in_tech_max - maximum replenishment amount (if replenishment is available)
- in_tech_min - minimum replenishment amount (if replenishment is available)
- out_fee - fee representation in the debit currency
- add - fixed debit fee amount
- max - maximum debit fee amount
- method - debit fee rounding method
- min - minimum debit fee amount
- mult - debit fee rate
- out_multipay_max - maximum debiting amount by multiple transactions (if debiting is available)
- out_singlepay_max - maximum debiting amount by single transaction (if debiting is available)
- out_tech_max - maximum debiting amount, equivalent to the value of
out_multipay_maxorout_singlepay_maxbased on the "Splitting transfer" setting in your account - out_tech_min - minimum debiting amount (if debiting is available)
- prec - minimum currency grain value
Exceptions
payway.activate
The method changes the status (activates) the payway for a merchant, who request it, and returns the result of the change.
Input method arguments
| Param | Required | Example | Description |
|---|---|---|---|
| payway | yes | "anycash" | payway name to be activated |
| is_out | no | False | direction of the currency transaction to be activated (True = outgoing payments, False = incoming payments). If not specified, activates both directions. |
Method response data
- <stis_active
- payway status for actual merchant
- m_lid
- local merchant ID
- payway
- payway name
Exceptions
- EParamMerchantInvalid
- merchant is inactive, request was sent from deleted or hidden merchant
- EParamNotFound
- merchant not found
- EParamPaywayInvalid
- transmitted payway name not found
- EStateForbidden
- it is forbidden to change the linked payway status
- EStateMerchantInactive
- request was sent from blocked merchant
- EStatePaywayUnavail
- merchant cannot deactivate transmitted payway (it is not public)
payway.deactivate
The method deactivates the payway for a merchant, who request it, and returns the result of the change.
Input method arguments
| Param | Required | Example | Description |
|---|---|---|---|
| payway | yes | "anycash" | payway name to be deactivated |
| is_out | no | False | direction of the currency transaction to be deactivated (True = outgoing payments, False = incoming payments). If not specified, deactivates both directions. |
Method response data
- is_active
- payway status for actual merchant
- m_lid
- local merchant ID
- payway
- deactivated payway name
Exceptions
- EParamMerchantInvalid
- merchant is inactive, request was sent from deleted or hidden merchant
- EParamNotFound
- merchant not found
- EParamPaywayInvalid
- transmitted payway name not found
- EStateForbidden
- it is forbidden to change the linked payway status
- EStateMerchantInactive
- request was sent from blocked merchant
- EStatePaywayUnavail
- merchant cannot deactivate transmitted payway (it is not public)