API Documentation
API Documentation
API Documentation
Bellow is description for each API Commands. Bear in mind that for each API command these required parameters must be provided:
Param Name | Type | Description |
---|---|---|
cmd | string | The command that needs to be executed |
password | string | Client's password |
token | string | Client's token |
data | array | Depending of command may be optional field. Associative array of options supported by request command |
Also each API Command will return these fields (along with result):
Param Name | Type | Description |
---|---|---|
code | int | Payment Code result of executed command |
status | string | Text description of returned Payment Code |
command | string | Executed Command |
result | mixed | Result of executed command. See command api docs for details |
request | mixed | Input params as received from request (useful for debugging purposes) |
ts | string | Request Timestamp |
origin_ip | string | IP Address from which request was sent |
debug | string | Internal PV2 debugg stuff, always null on production environment |
errors | array | Errors (if any) |
List of API Commands
List is available in document hierarchy section below.
Referenced Files
None
Subscribers
None
- Last Author
- aplawecki
- Last Edited
- Dec 10 2019, 06:41
Document Hierarchy
Document Hierarchy
- api.client.log
- api.rocketgatereasoncodes
- api.server.log
- api.statuscodes
- cards.add
- cards.get
- cards.list
- cards.remove
- cards.unblock
- cards.update
- items.get
- items.list
- notifications.hash.validate
- orders.change
- orders.get
- orders.list
- partner.info
- partner.list
- partner.password.set
- processor.accounts
- processor.fees
- processor.list
- processor.rebill-retry-plans
- processor.rg-mid-map
- subscription.cancel
- subscription.change
- subscription.get
- subscription.list
- subscription.reactivate
- transaction.chargeback
- transaction.create
- transaction.delete_chargeback
- transaction.finish
- transaction.get
- transaction.get.xsale
- transaction.init
- transaction.lastid
- transaction.list
- transaction.listsub
- transaction.refund
- users.changetrackingusers (REMOVED)
- users.search
- users.search-paypal