M2 API payment create

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

M2 API Create Payment

Create new payment from params. User balance will change.

[edit] Configuration

Go to SETTINGS -> Setup -> Settings->API tab and check API allow Payments

[edit] Usage

  • Call: /api/payment_create
  • Methods: POST, GET(if allowed, not recommended)

[edit] Parameters

Parameters which are included into hash:

  • user_id - User ID in MOR database, whose payment have to be done. Required.
  • amount - amount. Required.
  • currency - Currency code. Required.

Parameters which are not included into hash:

  • amount_in_tax - [0/1] default 0. If value 1, then amount param is given with tax included. Optional.
  • comment - comment of the payment. Optional.
  • payment_to_provider - [0/1] default 0. If value 0 Payment destination: is Payment from Client, if value 1 Payment destination: Payment to Provider. Optional.
  • exchange_rate - if currency is not default currency, than this value is used as exchange rate. Default value is default system exchange rate from Currencies. Optional.
  • u - username (admin/reseller) for authentication. Required.
  • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).

[edit] Request

We have user_id = 123, API Secret Key = 456789 We send:

HTML POST: http://<SERVER_IP>/billing/api/payment_create?u=admin&user_id=2&amount=96&currency=USD&amount_in_tax=1&exchange_rate=0.111&payment_to_provider=1&comment=testest&&hash=687a2cee0a61dee0bffa3bc8837e201a6a31af5d

NOTE that username and password are not included in hash

[edit] Returns


<?xml version="1.0" encoding="UTF-8"?>
  <payment currency="...">


  • <error>Bad login</error> - User supplied bad login.
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Currency was not foundy</error> - Currency not found in system.
  • <error>Access Denied</error> - User was not found or the current user(username (admin/reseller) for authentication) is not an owner of user which payment have to be done for.
  • <error>Amount was not found</error> - Amount was not given.
  • <error>Payment was not saved</error>
    • <message>Error message</message>

[edit] See also

Personal tools


Try M2