Services are modular plug and play configurations that add (or remove) functionality from your merchant account. AddPay provides merchants with 2 service types, Transaction Services and Module Services where Transaction Services act as a payment method and can be used to list available options to your customer or lock a particular transaction object to a single service.


Transaction Services

These are services which act as a payment method and may be used to collect, transfer or refund funds from and to a customer. These services are the most important as they are used within the API to construct transaction objects and allow the merchant to setup their own payment pages and/or enforce a specific payment method to be used under certain conditions.

Module Services

Services which provide additional functionality either from an API or within the merchant console. These services may or may not contain external API calls which allow them to be used within your application, however this is not the case for all modules, some act as an additional visual user-interface inside of the AddPay merchant console. See the Modules article for module services that provide an external consumption API layer.


The Service Object

Attributes

key
string
Unique key string per service, used as the identifier in transactions to lock a payment method to a transaction.
label
string
A human readable display name for the service.
description
string
An extended length description describing the label further.
icon
string
URL to the service resources icon image.
intent
array
A list of intent strings which identify the type of transactions allowed to be executed on the service used in conjunction with a transaction where:
SALE
Supports once-off transactions
SUBSCRIPTION
Supports recurring transactions
REFUND
Supports refunds
DONATION
Support donations, amount values provided by the customer


Get Transaction Services

GET /v2/services?type=transaction


Request

curl -s \
   --header "Content-Type: application/json" \
   --header "Authorization: Token :token" \
   --request GET "https://secure-test.addpay.co.za/v2/services?type=transaction"

Response

{
   "meta":{
      "status":"success",
      "message":"OK",
      "code":200
   },
   "data":[
      {
         "key":"DEBORDER",
         "label":"Debit Order",
         "description":"Mandated debit order bank transfer",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SUBSCRIPTION"
         ]
      },
      {
         "key":"BANKCARD",
         "label":"Visa\/MasterCard",
         "description":"Standard debit/credit card transaction",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SALE",
            "SUBSCRIPTION",
            "REFUND",
            "DONATION"
         ]
      }
   ]
}


Get Transaction Sale Services

GET /v2/services?type=transaction


Request

curl -s \
   --header "Content-Type: application/json" \
   --header "Authorization: Token :token" \
   --request GET "https://secure-test.addpay.co.za/v2/services?type=transaction&intent=sale"


Response

{
   "meta":{
      "status":"success",
      "message":"OK",
      "code":200
   },
   "data":[
      {
         "key":"BANKCARD",
         "label":"Visa/MasterCard",
         "description":"Standard debit\/credit card transaction",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SALE",
            "SUBSCRIPTION",
            "REFUND",
            "DONATION"
         ]
      }
   ]
}


Get Transaction Subscription Services

GET /v2/services?type=transaction


Request

curl -s \
   --header "Content-Type: application/json" \
   --header "Authorization: Token :token" \
   --request GET "https://secure-test.addpay.co.za/v2/services?type=transaction&intent=subscription"


Response

{
   "meta":{
      "status":"success",
      "message":"OK",
      "code":200
   },
   "data":[
      {
         "key":"DEBORDER",
         "label":"Debit Order",
         "description":"Mandated debit order bank transfer",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SUBSCRIPTION"
         ]
      },
      {
         "key":"BANKCARD",
         "label":"Visa/MasterCard",
         "description":"Standard debit\/credit card transaction",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SALE",
            "SUBSCRIPTION",
            "REFUND",
            "DONATION"
         ]
      }
   ]
}


Get Module Services

GET /v2/services?type=module


Request

curl -s \
   --header "Content-Type: application/json" \
   --header "Authorization: Token :token" \
   --request GET "https://secure-test.addpay.co.za/v2/services?type=module"


Response

{
   "meta":{
      "status":"success",
      "message":"OK",
      "code":200
   },
   "data":[
      {
         "key":"LINKGEN",
         "label":"AddPay Link",
         "description":"AddPay's payment link generator",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[

         ]
      },
      {
         "key":"SMS",
         "label":"SMS Service",
         "description":"SMS Service",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "NOTIFICATION"
         ]
      }
   ]
}


Get All Services

GET /v2/services


Request

curl -s \
  --header "Content-Type: application/json" \
  --header "Authorization: Token :token" \
  --request GET "https://secure-test.addpay.co.za/v2/services"


Response

{
   "meta":{
      "status":"success",
      "message":"OK",
      "code":200
   },
   "data":[
      {
         "key":"DEBORDER",
         "label":"Debit Order",
         "description":"Mandated debit order bank transfer",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SUBSCRIPTION"
         ]
      },
      {
         "key":"LINKGEN",
         "label":"AddPay Link",
         "description":"AddPay's payment link generator",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[

         ]
      },
      {
         "key":"SMS",
         "label":"SMS Service",
         "description":"SMS Service",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "NOTIFICATION"
         ]
      },
      {
         "key":"BANKCARD",
         "label":"Visa\/MasterCard",
         "description":"Standard debit/credit card transaction",
         "icon":"http://via.placeholder.com/82x82",
         "intent":[
            "SALE",
            "SUBSCRIPTION",
            "REFUND",
            "DONATION"
         ]
      }
   ]
}