Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


{{url}}/businesses/{{HO-business-ID }}/payers/{{payer-reference}}/schedules/payments{

Code Block
{
     "Date": "2020-06-27",

...


     "Amount": 100.00,

...


     "Reference": "Scheduled-Payment-001",

...


     "Description": "This is the first scheduled payment",

...


     "SubBusinessId": {{Sub-business Id}},

...


     "Audit":

...

 {
     "Username": "Example-User",

...


     "UserIP": "127.0.0.1"

...


   }
}

...

Card Payments

When processing a real time card payment that needs to be linked to a Sub Business you can use Head Office details for the login, as previously mentioned, and provide the Sub Business ID in the URL of the request.


{{url}}/businesses/{{Sub Business-Id}}/transactions/card-payments

Code Block
{

...


     "ProcessType": "COMPLETE",

...


     "Reference": "REAL-TIME-TXN-1001",

...


     "Description": "This is an example real-time transaction",

...


     "Amount": 100.25,

...


     "CurrencyCode": "AUD",

...


     "CardToken": "8854c380037544858cc6d56fee6983ec",

...


     "Payer":

...

 {
      "uniqueRefernce": "{{payer-reference}}"

...


     },

...


     "Audit":

...

 {
          "Username": "Example-User",

...


          "UserIP": "1.2.3.4"

...


   }
}

...

Saved Card Transaction

Processing a transaction using saved card details works in a similar was as Scheduling a single transaction. We use Head Office Business ID in the URL and the Sub Business ID in the body of the request, as below:


{{url}}//businesses/{{HO-business-ID }}/payers/{{payer-reference}}/transactions/card

Code Block
{

...


     "ProcessType": "COMPLETE",

...


     "Reference": "Transaction-001",

...


     "Amount": 100.75,

...


     "SubBusinessId": {{Sub-business Id}},

...


     "Description": "This is a test transaction",

...


     "CurrencyCode": "AUD",

...


     "Audit":

...

 {
       "Username": "Example-User",

...


       "UserIP": "1.2.3.4"

...


   }
}