Payment system

The payment providers an account can pay through, and what a given payment would cost.

A payment system is a provider the account can pay through. The list operation reports which are available and how each is configured, and the estimate operation reports what a given payment would actually cost, including any provider fee, before the user commits to it.

Payment system settings object

API actions

API base path: /payment_system.

Operations that list no errors of their own return only the general error codes.

---

Required sub-user rights: payment_create.

List payment systems

post

/payment_system/list

List the payment systems available to the current user.

Only systems enabled for the user's dealer and allowed for the user's legal type are returned, so an account with none configured gets an empty list rather than an error.

Callable with an empty body. Also accepts GET.

Requires the payment_create right.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Responses

200

Available payment systems

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/payment_system/list

POST /v2/payment_system/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "type": "text",
      "url": "text",
      "account": "text",
      "currency": "text",
      "payment_code": "text",
      "subscription_code": "text",
      "methods": [
        "text"
      ],
      "min_payment": 1,
      "max_payment": 1,
      "auto_payments_enabled": true,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Errors

These errors come in addition to the general error codes:

• 201 - Not found in the database.

---

Required sub-user rights: payment_create.

Get payment estimate

post

/payment_system/estimate/get

Return an estimate of the monthly payment amount for the current user.

Callable with an empty body. Also accepts GET.

Requires the payment_create right.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Responses

200

The estimate

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

valuenumberOptional

Estimated payment amount, rounded up to hundreds for rubles and to tens for other currencies.

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/payment_system/estimate/get

POST /v2/payment_system/estimate/get HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "value": 1
}