General
Login#
Returns a Bearer token. This token must be passed to all API calls.
Input#
| Param | Details |
|---|---|
| username | Username |
| password | Password |
Output#
| Param | Details |
|---|---|
| auth_token | Token to be used as a Bearer token in other API calls |
| refresh_token | |
| token_type | Always 'Bearer' |
| expires_in | Time to token expiry |
Payments#
Using Dashnetics to collect Payments#
Dashnetics can be used to collect payments via custom forms and integrated payment gateways.
Process#
Start Transaction process in Dashnetics
Send Users to page in Dashnetics
The URI is the payment page that has been setup. Pass the order ID returned from the call to start transaction as a parameter.
| Param | Details | |
|---|---|---|
| orderId | Required | order ID returned from call to Start Transaction |
| returnUrl | Optional | Url to return to after payment has been submitted by user |
Once user has submitted the form for payment they will either be returned to 'returnUrl' passed, or handled by Dashnetics.
Receive Status of Payment
Once payment has been processed Dashnetics will call URL passed as callback in Start Transaction with the result of the payment
Start Payment#
Starts a payment transaction in Dashnetics
Input#
| Param | Details |
|---|---|
| amount | Amount of the payment in cents |
| description | Description of the payment, can be shown to users in the Dashnetics form |
| info | Payment information sent to the payment gateway |
| callback | URI to callback with the results of the payment |
Output#
| Param | Details |
|---|---|
| orderId | Order ID to be sent to Dashnetics |
Payment Result#
Sent back to callback URI sent in Start Payment
Output#
| Param | Details |
|---|---|
| dateSent | Date and time sent to payment gateway |
| status | Status of Transaction "Success" or "Failure" |
| bankTransactionId | Id of the payment from the payment gateway |
| message | Message from the payment gateway. If status is Failure, will be the cause of the failure |