Skip to main content

General

Login#

Returns a Bearer token. This token must be passed to all API calls.

POST https://<Dashnetics domain>/rest2/login

Input#

{
"username": "<USERNAME>",
"password": "<PASSWORD>"
}
ParamDetails
usernameUsername
passwordPassword

Output#

{
"auth_token": "XXX",
"refresh_token": "YYY",
"token_type": "Bearer",
"expires_in": 8400
}
ParamDetails
auth_tokenToken to be used as a Bearer token in other API calls
refresh_token
token_typeAlways 'Bearer'
expires_inTime to token expiry

Payments#

Using Dashnetics to collect Payments#

Dashnetics can be used to collect payments via custom forms and integrated payment gateways.

Process#

  1. Start Transaction process in Dashnetics

  2. Login

  3. Start Transaction

  4. Send Users to page in Dashnetics

  5. The URI is the payment page that has been setup. Pass the order ID returned from the call to start transaction as a parameter.

https://Dashnetics.com.au/payment?orderId=<your orderId>&return=<Uri to return to after payment is submitted>
ParamDetails
orderIdRequiredorder ID returned from call to Start Transaction
returnUrlOptionalUrl to return to after payment has been submitted by user
  1. Once user has submitted the form for payment they will either be returned to 'returnUrl' passed, or handled by Dashnetics.

  2. Receive Status of Payment

  3. 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

POST https://<Dashnetics domain>/rest2/payment/create

Input#

{
"amount":10000,
"description: "Test Payment",
"info": "Payment 1",
"callback": "https://your.callback.url"
}
ParamDetails
amountAmount of the payment in cents
descriptionDescription of the payment, can be shown to users in the Dashnetics form
infoPayment information sent to the payment gateway
callbackURI to callback with the results of the payment

Output#

{
"orderId": "XXX"
}
ParamDetails
orderIdOrder ID to be sent to Dashnetics

Payment Result#

Sent back to callback URI sent in Start Payment

Output#

{
"dateSent": "2020-07-28T00:15:02.868Z",
"status": "Success",
"bankTransactionId": "111111",
"message": "Transaction successful"
}
ParamDetails
dateSentDate and time sent to payment gateway
statusStatus of Transaction "Success" or "Failure"
bankTransactionIdId of the payment from the payment gateway
messageMessage from the payment gateway. If status is Failure, will be the cause of the failure