Difference between revisions of "MOR API payment create"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 1: Line 1:
'This functionality is available from [[MOR 12| MOR 12]]''
<!---This functionality is available from MOR 12--->




[[MOR API]]
[[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->Payments or Payment gateways).
Create new payment from params. '''User balance will change''' if new payment is completed and admin confirmation is off in the settings (Settings->Payments or Payment gateways).


To turn on : Settings->Api->API allow Payments
To turn on : Settings->Api->API allow Payments
<br><br>
<br><br>
----
----
<br><br>
* Call: /api/create_payment
* Call: /api/create_payment
* Methods: POST, GET(if allowed, not recomended)
* Methods: POST, GET(if allowed, not recomended)

Revision as of 14:37, 1 March 2013


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->Payments or Payment gateways).

To turn on : Settings->Api->API allow Payments


  • Call: /api/create_payment
  • Methods: POST, GET(if allowed, not recomended)
  • Params:
    • user_id - User ID in MOR database, whose financial statement we want to see. 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) to login. Required.
    • p - password (admin/reseller) to login. Required.
    • hash - SHA1 hash constructed using user_id and API_Secret_Key ( More described in Constructing hash). Required.
  • Returns:
    • Success
<response>
 <status>ok</status>
 <payment currency="...">
   <payment_id>...</payment_id>
   <tax>...</tax>
   <amount>...</amount>
   <gross>...</gross>
 </payment>
</response>
    • Errors:
      • <error>Bad login</error> - User supplied bad login or password.
      • <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>Payment was not saved</error>
        • <message>Error message</message>




  • Example:
    • We have user_id = 123, API Secret Key = 456789
    • Hash string to be converted: "123456789"
    • We might send:
      • //api/create_payment?user_id=123&p_currency=EUR&paymenttype=Myname&tax_in_amount=1&amount=100&transaction=2S5sdf77&payer_email=bla&u=admin&p=admin&hash=687a2cee0a61dee0bffa3bc8837e201a6a31af5d

* Note that username and password are not included in hash