MOR API payment create

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API Create Payment

Create new payment from params. User balance will change if new payment is completed and admin confirmation is off in the settings (SETTINGS > Setup > Settings > API, option "API Payment Confirmation").

[edit] Configuration

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

[edit] Usage

  • From MOR X4 call: /api/payment_create
  • For Backwards-compatibility old name 'create_payment' is also usable. Call: /api/create_payment
  • Methods: POST, GET(if allowed, not recomended)



[edit] Parametres

  • user_id - User ID in MOR database, whose payment have to be done. Required.
  • p_currency - Currency code.Required.
  • paymenttype - payment getaway name. Optional.
  • tax_in_amount - [0/1] default 0. Optional.
  • amount - amount. Required.
  • transaction - transaction ID. Optional.
  • payer_email - payer email. 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=123&p_currency=EUR&paymenttype=Myname&tax_in_amount=1&amount=100&transaction=2S5sdf77&payer_email=bla&u=username&hash=687a2cee0a61dee0bffa3bc8837e201a6a31af5d

NOTE that username and password are not included in hash

[edit] Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <response>
  <status>ok</status>
  <payment currency="...">
    <payment_id>...</payment_id>
    <tax>...</tax>
    <amount>...</amount>
    <gross>...</gross>
  </payment>
 </response>
</page>




Errors

  • <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>No currency</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>Payment was not saved</error>
    • <message>Error message</message>



[edit] See also

Personal tools

Try MOR

Try M2