Difference between revisions of "MOR API payments get"
From Kolmisoft Wiki
Jump to navigationJump to search
Line 53: | Line 53: | ||
</payments> | </payments> | ||
</page> | </page> | ||
<br><br> | |||
---- | |||
*Example: | |||
**We have s_user_id = 123, API Secret Key = 456789 | |||
**Hash string to be converted: "123456789" | |||
**We send: | |||
***/api/payments_list?u=admin&p=admin&s_user_id =123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441 | |||
'''* Note that username and password are not included in hash''' |
Revision as of 14:19, 22 December 2011
This functionality is available from MOR_11
MOR API
Payments list
- Call: /api/payments_list
- Params:
- u - username to login. Required.
- p - password to login. Required.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
- s_user_id - payments user id.
- s_from - Unix timestamp of calls period starting date. (Default: Today at 00:00).
- s_till - Unix timestamp of calls period end date. (Default: Today at 23:59).
- s_transaction - transaction id.
- s_completed - payment status. Possible values[ 1 - completed, 0 - not completed, if not sent - default: All]
- s_username - users username.
- s_first_name - users first name.
- s_last_name - users last name
- s_paymenttype - payment type. Possible values['Card', 'paypal','webmoney','ouroboros','manual','gateways_paypal','gateways_authorize_net','integrations_moneybooker','integrations_two_checkout', if not sent - default: All]
- s_amount_min - amount starting from.
- s_amount_max - amount ending with.
- s_currency - payment currency. Example: USD
- s_number - card number.
- s_pin - card pin.
- Errors:
- <error>Bad login</error> - User was not found by username and password. Use correct username and password. Make sure that username (u) and password (p) are specified.
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- Returns:
<page> <pagename> Payments_list </pagename> <payments> <payment> <user> payment user </user> <payer> email or payer </payer> <transaction_id> transaction id </transaction_id> <date> date added </date> <confirm_date> confirm date </confirm_date> <type> payment type </type> <amount> payment amount </amount> <fee> payment fee </fee> <amount_with_tax> payment amount with tax </amount_with_tax> <currency> payment currency </currency> <completed> payment status </completed> <confirmed_by_admin> confirmed by admin? </confirmed_by_admin> </payment> </payments> </page>
- Example:
- We have s_user_id = 123, API Secret Key = 456789
- Hash string to be converted: "123456789"
- We send:
- /api/payments_list?u=admin&p=admin&s_user_id =123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
* Note that username and password are not included in hash