Our set of API allows you to integrate our services, manage organisations, users in a simple and programmatic way, using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions.
The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints.
In settings you can configure your success, refund and error webhook urls. The result will be sent as an HTTP POST request in the following format:
We do not have static IPs to whitelist and we recommend doing lookup api calls:
Payments: /api/v1/gateway-transaction/$GATEWAY_TRANSACTION_ID
Payouts: /api/v1/payout/100/$PAYOUT_TRANSACTION_ID
POST = [
'success' => {1 or 0}
'status' => {statusString}
'organisation_id' => {merchant_id}
'amount' => {amount}
'callpay_transaction_id' => {gateway_transaction_id}
'reason' => ‘{reasonForFailureIfApplicable}’
'user' => ‘{paymentUser}’
'merchant_reference' => ‘{merchant_reference}’
'gateway_reference' => ‘{psp_reference}'
'gateway_response' => ‘{additionalDataFromPSP}’
'currency' => ‘{currency}’
'payment_key' => ‘{payment_key}’
]
POST = [
'success' => {1 or 0}
'organisation_id' => {merchant_id}
'refunded_amount' => {amountRefunded}
'callpay_transaction_id' => {gateway_transaction_id}
'reason' => ‘{reasonForFailureIfApplicable}’
'user' => ‘{paymentUser}’
'merchant_reference' => ‘{merchant_reference}’
'gateway_reference' => ‘{psp_reference}'
'currency' => ‘{currency}’
'payment_key' => ‘{payment_key}’
'gateway_response' => ‘{additionalDataFromPSP}’
]
Payment Methods | Integration methods | Activated |
---|---|---|
Agent Assist A call center service for taking payment details while on call. |
Redirect & Enterprise | No |
Agent Monitor A call center service for taking payment details by forwarding the customer on the call to an IVR |
Redirect & Enterprise | No |
Agent Request A call center service for taking payment details over network initiated USSD. |
Enterprise | No |
Credit Card Payments A website or mobile service for accepting credit card payments via a redirect. |
Checkout & Redirect & Enterprise | No |
EFTsecure A website or mobile service for accepting instant EFT |
Checkout & Redirect & Enterprise | Yes |
Notify Express (Pay by Link) A notification service for Pay Direct and EFTsecure. Email, SMS and Link supported. |
Enterprise | No |
Snapscan Accept Snapscan payments by scanning a QR Code as an option through the checkout widget. |
Checkout & Redirect | No |
Zapper Accept Zapper payments by scanning a QR Code as an option through the checkout widget. |
Checkout & Redirect | No |
OTT-Voucher Accept Voucher payments as an option through the checkout widget. |
Checkout & Redirect | No |
1Voucher Accept Voucher payments as an option through the checkout widget. |
Checkout & Redirect | No |
BluVoucher Accept Voucher payments as an option through the checkout widget. |
Checkout & Redirect | No |
EasyPay Voucher (Kazang Voucher) Accept Voucher payments as an option through the checkout widget. |
Checkout & Redirect | No |
Masterpass Accept payments by scanning a QR code using any Masterpass app. |
Checkout & Redirect | No |
Mobicred Accept payments through a Micro loans provider, as and option from the checkout widget. |
Checkout & Redirect | No |
Fasta Accept payments through a Micro loans provider, as and option from the checkout widget. |
Checkout & Redirect | No |
Epos Accept data payloads for validation. |
No | |
Chinapay |
Checkout & Redirect | No |
Pay just Now Accept payments through a Micro loans provider, as and option from the checkout widget. |
Checkout & Redirect | No |
Payflex Accept payments through a Micro loans provider, as and option from the checkout widget. |
Checkout & Redirect | No |
Crypto Accept Crypto payments as an option through the checkout widget. |
Checkout & Redirect | No |
Vfd Accept Vfd payments as an option through the checkout widget. |
Checkout & Redirect | No |
Shop 2 Shop Voucher Accept Voucher payments as an option through the checkout widget. |
Checkout & Redirect | No |
Capitec Pay Accept Capitec Pay payments as an option through the checkout widget. |
Checkout & Redirect | No |
Fivewest Accept Fivewest payments as an option through the checkout widget. |
Checkout & Redirect | No |
Capitec EFT Accept Capitec EFT payments as an option through the checkout widget. |
Checkout & Redirect | No |
RealPay Capitec Pay Accept RealPay Capitec Pay payments as an option through the checkout widget. |
Checkout & Redirect | No |
Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.
Method | Usage |
---|---|
GET |
For simple retrieval of information you should use the GET method. The information you request will be returned to you as a JSON object. |
DELETE |
To destroy a resource and remove it from your account and environment, the DELETE method should be used. |
PUT |
To update the information about a resource in your account, the PUT method is available. |
POST |
To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint. |
Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes.
In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered.
In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered.
Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.
If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.
{
"name": "Unauthorized",
"message": "",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
When a request is successful, a response body will typically be sent back in the form of a JSON object.
For example, if you send a GET request to /api/v1/user/$USER_ID
you will get back an object for that user. If you send the GET request /api/v1/organisation/$ORGANISATION_ID/user
you will get back an array of objects.
{
"id": 1,
"name": "John",
...
}
[
{
"id": 1,
"name": "John",
...
},
{
"id": 2,
"name": "Joe",
...
},
{
"id": 3,
"name": "Jane",
...
}
]
A token must be sent in the headers of a request for authentication
A token can be created for a user by making an API call with basic authentication (a valid user's username and password must be sent as credentials) to following URL:
Keep in mind that Agent users are limited to service api calls that they are authorised to use.
curl -X POST -u validusername:validpassword https://eftsecure.callpay.com/api/v1/token
{
"token": "b5cfaae0e94e79d0073f4925143dca2c",
"expires": "2016-09-07 08:46:16"
}
Some of these constants are required for certain API calls.
These are the service IDs available to your organisation.
ID | Service |
---|---|
12 | EftX |
List of available gateways
ID | Gateway |
---|---|
1 | PayU |
List of available user roles
Post with string value
eg. User[role] = 'agent'
Role | Description |
---|---|
administrator | User that can manage the organisation and users |
agent | Call centre agent that uses our services |
Allows agents and apps to make use of our services through the API.
The payment key is a setup identifier for each payment and required by EFTsecure and Checkout integrations.
Url: https://eftsecure.callpay.com/api/v1/payment-key
The response will contain a key that can be used for the checkout widget or redirect.
Important notes for EFT payments
Shared parameters:
Attribute | Type | Description | Required |
---|---|---|---|
token | Auth token | ie. c8e542542bcd6b35a5bb708a6df66f08 | If no basic auth |
amount | decimal[10,2] | 10.00 | Yes |
merchant_reference | string | transaction reference for merchant | Yes |
customer_reference | string | transaction reference for customer | No |
success_url | string | Redirect url for success | No |
error_url | string | Redirect url on error | No |
cancel_url | string | Redirect url on cancel | No |
notify_url | string | Webhook for getting notified about results | No |
payment_type | string | Which payment type to offer the customer eg. [eft] Will determine hosted endpoint in response. |
No |
currency_code | string | Country currency code, will return supported services for that currency eg. [ZAR, NGN] Will default to the organisation default currency |
No |
EFT payment parameters:
Attribute | Type | Description | Required |
---|---|---|---|
customer_bank | string | For pre-selecting a bank for the first step | No |
listed_beneficiary_account | string OR associative array(see above**) | The account number reference for the customer if merchant is public listed beneficiary at the bank | No |
default_beneficiary_reference | string | The default reference when creating the beneficiary. Useful for account numbers. | No |
beneficiary_account_number | string | To override beneficiary account number. | No |
beneficiary_name | string | To override beneficiary name. | No *required if beneficiary account number set |
beneficiary_account_type | string | Beneficiary account type [cheque, savings, transmission] |
No *required if beneficiary account number set |
beneficiary_bank | string |
Beneficiary account number bank [ABSA, Nedbank, Capitec, FNB, Standard, Investec] |
No *required if beneficiary account number set |
hash | string | A sha256 hash of account details and API salt | No *required if beneficiary account number set |
eft_token | guid | Eft Token to be used for recurring transactions Note: This can only be sent if payment_type is eft |
No |
curl -X POST -u validusername:validpassword https://eftsecure.callpay.com/api/v1/payment-key -d "amount=1&merchant_reference=testref123"
{
"key": "4ea1ea853463dab5b24f7066c1fc8f4b",
"url": "https://eftsecure.callpay.com/eft?payment_key=4ea1ea853463dab5b24f7066c1fc8f4b",
"origin": "https://eftsecure.callpay.com"
}
// PHP
$stringToHash = $beneficiary_account_number.$beneficiary_name.$beneficiary_account_type.$beneficiary_bank.$api_salt;
$hash = hash('sha256', strtolower($stringToHash));
// RUBY
require 'digest'
stringToHash = beneficiary_account_number+beneficiary_name+beneficiary_account_type+beneficiary_bank+api_salt;
hash = Digest::SHA256.hexdigest(stringToHash.downcase);
// PYTHON
import hashlib
string_to_hash = beneficiary_account_number+beneficiary_name+beneficiary_account_type+beneficiary_bank+api_salt
hash = hashlib.sha256(string_to_hash.lower()).hexdigest()
The EFTsecure service is our instant EFT payment method. It requires a customer to login as if on their internet banking system and automates the rest of the payment process and notifies to merchant through web hooks or enterprise api's that the payment has been made. A merchants banking details can be setup under settings→eft in the admin console.
Integration methods:
Requirements
Our hosted method for instant EFT's requires minimal development.
It requires a redirect to a endpoint which will in turn be the payment page hosted on our platform.
After a payment is complete we can notify your system through our web hooks or you can do a lookup of the transaction.
First you will need to create a payment key. This will be used to setup the payment.
https://eftsecure.callpay.com/eft?payment_key={generatedPaymentKey}
This integration method gives you more flexibility and allows you to host it on your own website/platform.
You can apply your own stylesheet or use our bootstrap stylesheet. See framework option in the javascript library.
After a payment is complete we can notify your system through our web hooks or you can do a lookup of the transaction.
First you will need to create a Payment key. This will be used by the library to authenticate every jsonp call and save your initial data.
Then you will need to copy a code snippet (see example below) onto your page which will invoke a EFTsecure javascript plugin. Link to javascript plugin
EFTsecure javascript plugin parameters:
Attribute | Type | Description | Required |
---|---|---|---|
key | string | Payment key generated server side | Yes |
baseUrl | string Default:https://eftsecure.callpay.com |
Overrides base url for plugin api calls (eg. for white labelled domains) | No |
formId | string default:"eftx-form" |
The html ID of the form to populate | No |
titleId | string default:"eftx-title" |
The html ID of the primary heading to populate | No |
subTitleId | string default:"eftx-subtitle" |
The html ID of the secondary heading to populate | No |
cssFramework | string[plain,bootstrap] default:"plain" |
How to format the html for the form | No |
buttonContainerId | string | Override to specify a specific button container | No |
onLoadStart | callback | Executed when form is submitted on each step | No |
onLoadStop | callback | Executed when result is received for each step | No |
Add the following to your <head> tag:
<!-- If you do not already use jQuery include it -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="https://eftsecure.callpay.com/js/eft-secure.min.js"></script>
Copy and paste the following html and insert the dynamic {{parameters}}:
<!-- Eftx plain START -->
<h1 id="eftx-title">Initialising Transaction</h1>
<div>Merchant: {{merchantName}} ({{merchantBank}}), Amount: {{currencyFormattedAmount}}</div>
<h2 id="eftx-subtitle"></h2>
<div id="loader" style="display: none;">Loading...</div>
<form id="eftx-form" autocomplete="false"></form>
<div style="clear:both"></div>
<div id="eftx-button-container"></div>
<script>
$(document).ready(function() {
new Eftx({
key: "{{paymentKey}}",
formId: "eftx-form",
titleId: "eftx-title",
subTitleId: "eftx-subtitle",
cssFramework: "plain",
buttonContainerId: "eftx-button-container",
//onCancelUrl: "{{yourCancelUrl}}",
//onCompleteUrl: "{{yourCompleteUrl}}",
onLoadStart: function(){
$("#loader").hide();
$("#eftx-form").hide();
$("#eftx-button-container").hide();
//Do other stuff here
},
onLoadStop: function(){
$("#loader").addClass("hide");
$("#eftx-form").show();
$("#eftx-button-container").show();
//Do other stuff here
}
});
});
</script>
<!-- Eftx plain END -->
Add the following to your <head> tag:
<!-- If you do not already use jQuery include it -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="https://eftsecure.callpay.com/js/eft-secure.min.js"></script>
<link rel="stylesheet" type="text/css" href="https://eftsecure.callpay.com/css/eftx.css">
Copy and paste the following html and insert the dynamic {{parameters}}:
<!-- Eftx boostrap START -->
<div class="eft modal" id="eftxModal" tabindex="-1" role="dialog" aria-labelledby="title">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title pull-left" id="eftx-title">Initialising Transaction</h4>
<h4 class="modal-title pull-right">Amount: {{currencyFormattedAmount}}</h4>
<div class="clearfix"></div>
<div>Merchant: {{merchantName}} ({{merchantBank}})</div>
</div>
<div class="modal-body">
<h4 id="eftx-subtitle"></h4>
<div class="eftx-loader">
<div class="container">
<div class="loader">
<div class="loader--dot"></div>
<div class="loader--dot"></div>
<div class="loader--dot"></div>
<div class="loader--dot"></div>
<div class="loader--dot"></div>
<div class="loader--dot"></div>
<div class="loader--text"></div>
</div>
</div>
</div>
<form id="eftx-form" autocomplete="false"></form>
<div class="clearfix"></div>
</div>
<div class="modal-footer" id="eftx-button-container">
</div>
</div>
</div>
</div>
<script type="text/javascript">
$(document).ready(function() {
new Eftx({
key: "{{paymentKey}}",
//enum[bootstrap, none]
cssFramework: "bootstrap",
buttonContainerId: "eftx-button-container",
//onCancelUrl: "{{yourCancelUrl}}",
//onCompleteUrl: "{{yourCompleteUrl}}",
backgroundEnabled: true,
onLoadStart: function(){
$(".eftx-loader").removeClass("hide"); $("#eftx-form").hide();
$(".modal-footer button").hide();
//Do other stuff here
},
onLoadStop: function(){
$(".eftx-loader").addClass("hide"); $("#eftx-form").show();
$(".modal-footer button").show();
//Do other stuff here
}
});
});
</script>
<!-- Eftx bootstrap END -->
This integration method allows you to host EFT payments on your own website/platform and still descope you from PCI compliance.
NB: A SSL certificate is required to ensure compatibility with the frame.
First you will need to create a Payment key. This will be used by the widget to authenticate the payment in the frame.
NB: When creating a payment key you must specify the redirect success and error urls, if not set page will redirect to default receipt page after transaction
You will need to copy a code snippet (see example below) onto your page which will invoke a EFTsecure checkout widget. Click here to view a live example
Checkout widget parameters:
Attribute | Type | Description | Required |
---|---|---|---|
paymentKey | string | Payment key generated server side | Yes |
paymentType | string |
Force payment type [eft] | No |
onLoad | event | Override for example re-enable payment button | No |
cardOptions | object | Enable Card options Eg. "rememberCard" default value 0 | No |
Add the following to your <head> tag:
<!-- If you do not already use jQuery include it -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
<!-- The data-origin attribute value is the origin value returned from the payment key API call -->
<!-- Also ensure that the id attribute is set to og-checkout -->
<script type="text/javascript" src="https://eftsecure.callpay.com/ext/checkout/v3/checkout.js" id="og-checkout" data-origin="https://eftsecure.callpay.com"></script>
Copy and paste the following html and insert the dynamic {{parameters}}:
<form id="#payment-form" action="/checkout?confirm=1" style="margin-top: 50px">
<div class="text-center">
<button id="pay-button" class="btn btn-primary btn-sx" type="button" data-payment-key="{{paymentKey}}">Pay</button>
</div>
</form>
<script type="text/javascript">
$(function() {
$('#pay-button').on('click', function() {
$(this).hide();
var paymentKey = $(this).data('payment-key');
eftSec.checkout.init({
paymentKey: paymentKey,
paymentType: 'credit_card', // optional: force payment type
onLoad: function() {
$('#pay-button').show();
},
cardOptions: { //optional for Tokenizing Card
rememberCard: false,
rememberCardDefaultValue: 0
},
});
});
});
</script>
Allows you to view/confirm or list a organisation transactions.
Fetch all transactions for an organisation by organisation id.' Organisation id is required in url
Request Method: GET
Url: https://eftsecure.callpay.com/api/v1/organisation/$ORGANISATION_ID/gateway-transaction
Returned attributes per transaction:
Attribute | Type | Description |
---|---|---|
id | integer | unique primary key for transaction |
successful | integer | integer indicating whether transaction was successful or not (1 being true 0 being false) |
amount | decimal | transaction amount |
gateway_reference | text | payment gateway reference number |
created | date | date and time of transaction |
service | text | name of service used by agent |
from_date | date (dd-mm-yyyy) | Where date >= |
to_date | date (dd-mm-yyyy) | Where date <= |
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/organisation/$ORGANISATION_ID/gateway-transaction
[
{
"id": 166,
"successful": 1,
"amount": "123.00",
"gateway_reference": "Gateway_merchant_ref_1434026074",
"created": "2015-06-11 12:34:34",
"service": "Scan Card"
},
{
"id": 167,
"successful": 1,
"amount": "123.00",
"gateway_reference": "Gateway_merchant_ref_1434026303",
"created": "2015-06-11 12:38:23",
"service": "POS"
},
{
"id": 168,
"successful": 1,
"amount": "123.00",
"gateway_reference": "Gateway_merchant_ref_1434027451",
"created": "2015-06-11 12:57:31",
"service": "POS"
}
]
Download a csv containing transactions. Can be filtered by the parameters in the table below.
Request Method: GET
Url: https://eftsecure.callpay.com/api/v1/export/gateway-transactions
Filtering attributes:
Parameter | Type | Description |
---|---|---|
from_date | date (dd-mm-yyyy) | Where date >= |
to_date | date (dd-mm-yyyy) | Where date <= |
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/export/gateway-transactions?from_date=19-02-2024&to_date=19-03-2024
Fetch all transactions for user by user id.User id is required in url
Request Method: GET
Url: https://eftsecure.callpay.com/api/v1/user/$USER_ID/gateway-transaction
Returned attributes per transaction:
Attribute | Type | Description |
---|---|---|
id | integer | unique primary key for the transaction |
successful | integer | integer indicating whether transaction was successful or not (1 being true 0 being false) |
amount | decimal | transaction amount |
gateway_reference | text | payment gateway reference number |
created | date | date and time of transaction |
service | text | name of service used by agent |
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/user/$USER_ID/gateway-transaction
[
{
"id": 166,
"successful": 1,
"amount": "123.00",
"gateway_reference": "Gateway_merchant_ref_1434026074",
"created": "2015-06-11 12:34:34",
"service": "Scan Card"
},
{
"id": 167,
"successful": 1,
"amount": "123.00",
"gateway_reference": "Gateway_merchant_ref_1434026303",
"created": "2015-06-11 12:38:23",
"service": "POS"
},
{
"id": 168,
"successful": 1,
"amount": "123.00",
"gateway_reference": "Gateway_merchant_ref_1434027451",
"created": "2015-06-11 12:57:31",
"service": "POS"
}
]
View transaction by id. Will be sent back as single object and status 200. Transaction id is required
Request Method: GET
Url: https://eftsecure.callpay.com/api/v1/gateway-transaction/$GATEWAY_TRANSACTION_ID
Returned attributes:
Attribute | Type | Description |
---|---|---|
id | integer | unique primary key for transaction |
successful | integer | integer indicating whether transaction was successful or not (1 being true 0 being false) |
amount | decimal | transaction amount |
gateway_reference | text | payment gateway reference number |
created | date | date and time of transaction |
service | text | name of service used by agent |
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/gateway-transaction/$GATEWAY_TRANSACTION_ID
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/gateway-transaction/?reference=$MERCHANT_REFERENCE
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/gateway-transaction/?key=$PAYMENT_KEY
{
"id": 11111,
"successful": 1,
"status": "complete",
"amount": "5.00",
"reason": "n/a",
"displayAmount": "R5.00",
"currency": "ZAR",
"merchant_reference": "1111111-11111-1111",
"gateway_reference": "11111111-0000-0000-0000-000000000000",
"payment_key": "19440ff6006e2179ea4bbd6b470693ee",
"created": "2021-02-18 11:59:58",
"refunded_amount": "0.00",
"refunded": 0,
"service": "Direct",
"gateway_response_parameters": {
"accountFrom": "30",
"accountTo": "00",
"amount": 500,
"authCode": "843199",
"card": "424242*****4242",
"cardName": "Diners",
"cardToken": "1111111-1111-1111-1111-1111111",
"currency": "710",
"dmsIndicator": false,
"echo": "52857350-dd49-46df",
"pos": "00173138",
"reference": "22117406-0000-0000-0000-000000000000",
"responseCode": "00",
"responseText": "Approved",
"rrn": "00001111111",
"seq": "1111111",
"store": "000000001111111",
"storeDetails": {
"city": "Cape Town ",
"country": "ZA",
"name": "Store name",
"region": "WC"
},
"tran": "00",
"tranQualifier": "008601",
"gatewayCardToken": "1111111-1111-1111-1111-1111111",
"card_token": "1111111-1111-1111-1111-1111111", // Token to be re-used
"bin": "424242"
},
"call": "",
"location": "",
"signature": null,
"is_demo_transaction": 1,
"token": "1111111-1111-1111-1111-1111111", // Token to be re-used
}
Some gateways supports refund capability of the full amount.
Request Method: PUT
Url: https://eftsecure.callpay.com/api/v1/gateway-transaction/refund/{$transaction_id}
By default this will refund the complete transaction amount.
Attribute | Type | Description |
---|---|---|
amount | float | Optional. Amount lower or equal to the transaction amount. |
curl -X PUT -u validusername:validpassword https://eftsecure.callpay.com/api/v1/gateway-transaction/refund/12345678
{
"result": true
}
This API call allows you to resend a webhook for a transaction.
Request Method: POST
Url: https://eftsecure.callpay.com/api/v1/gateway-transaction/resend-webhook/{$gateway_transaction_id}
This will allow you to resend your webhook and the API call requires a custom URl to attribute
Attribute | Type | Description | Required |
---|---|---|---|
url | string | URL to post webhook data to | Yes |
curl -X POST -u validusername:validpassword https://eftsecure.callpay.com/api/v1/gateway-transaction/resend-webhook/{$gateway_transaction_id} -d 'url=https://yoursite.com/webhook-endpoint'
{
"success": true,
"message": "Webhook has been queued successfully"
}
Allows you manage organisation users.
Fetch all users for an organisation by organisation id.' Organisation id is required in url
Request Method: GET
Url: https://eftsecure.callpay.com/api/v1/organisation/$ORGANISATION_ID/user
Returned attributes per user:
Attribute | Type | Description |
---|---|---|
id | integer | unique primary key for user |
name | text | user first name |
lastname | text | user last name |
username | text | user username |
valid email address | user email address | |
contact_number | integer | user contact number |
organisation_id | integer | user organisation id |
created | date | date user was created |
extension | integer | If user is type agent will return an extension for him/her |
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/organisation/$ORGANISATION_ID/user
[
{
"id": 2,
"name": "John",
"lastname": "Doe",
"username": "johndoe",
"email": "johndoe@merchantcompany.co.za",
"contact_number": 0821234567,
"organisation_id": 3,
"created": "2015-02-03 14:19:39",
"extension": "4444"
},
{
"id": 3,
"name": "Joe",
"lastname": "Doe",
"username": "joedoe",
"email": "joedoe@merchantcompany.co.za",
"contact_number": 0821234567,
"organisation_id": 3,
"created": "2015-02-03 14:19:39",
"extension": "5555"
}
]
View existing user by User id. Will be sent back as single object and status 200. User id is required
Request Method: GET
Url: https://eftsecure.callpay.com/api/v1/user/$USER_ID
Returned attributes:
Attribute | Type | Description |
---|---|---|
id | integer | unique primary key for user |
name | text | user first name |
lastname | text | user last name |
username | text | user username |
valid email address | user email address | |
contact_number | integer | user contact number |
organisation_id | integer | user organisation id |
created | date | date user was created |
extension | integer | If user is type agent will return an extension for him/her |
curl -X GET -u validusername:validpassword https://eftsecure.callpay.com/api/v1/user/3
{
"id": 3,
"name": "Joe",
"lastname": "Doe",
"username": "joedoe",
"email": "joedoe@merchantcompany.co.za",
"contact_number": 0821234567,
"organisation_id": 3,
"created": "2015-02-03 14:19:39",
"extension": "5555"
}
Create new user Will be send back a single object (see View User for returned attributes) and status 201 (Created).
Request Method: POST
Url: https://eftsecure.callpay.com/api/v1/user
User Post parameters: post as User[$ATTRIBUTE]
Attribute | Type | Description | Required |
---|---|---|---|
username | text | user username | Yes |
role | valid user role | See list of user roles | Yes |
password | text | user password | No |
name | text | user first name | No |
lastname | text | user last name | No |
valid email address | user email address | No | |
contact_number | integer | user contact number | No |
curl -X POST -u validusername:validpassword https://eftsecure.callpay.com/api/v1/user -d "User[username]=unique&User[role]=agent"
{
"id": 8,
"name": null,
"lastname": null,
"username": "unique",
"email": null,
"contact_number": null,
"organisation_id": 3,
"created": "2015-02-03 14:19:39",
"extension": null
}
Update existing organisation by User id.User id is required in url'); ?>
Request Methods: PUT
Url: https://eftsecure.callpay.com/api/v1/user/$USER_ID
User Put parameters: post as User[$ATTRIBUTE]
Attribute | Type | Description |
---|---|---|
username | text | user username |
password | text | user password |
role | valid user role | See list of user roles |
name | text | user first name |
lastname | text | user last name |
valid email address | user email address | |
contact_number | integer | user contact number |
curl -X PUT -u validusername:validpassword https://eftsecure.callpay.com/api/v1/user/8 -d "User[name]=Jason"
{
"id": 8,
"name": "Jason",
"lastname": null,
"username": "unique",
"email": null,
"contact_number": null,
"organisation_id": 3,
"created": "2015-02-03 14:19:39",
"extension": null
}
Allows you to update organisation licenses and activate/deactivate agent licenses.
Update amount of licenses organisation has for a service by Organisation id.Organisation id is required in url
Request Method: PUT
Url: https://eftsecure.callpay.com /api/v1/organisation/$ORGANISATION_ID/licenseupdate
Put parameters: post array of service ids with service id as key and amount of licenses as value
eg. serviceId[$SERVICE_ID_ONE]=$AMOUNT_OF_LICENSES
eg. serviceId[$SERVICE_ID_TWO]=$AMOUNT_OF_LICENSES
See available service IDs
curl -X PUT -u validusername:validpassword https://eftsecure.callpay.com/api/v1/organisation/10/licenseupdate -d "serviceId[1]=25&serviceId[2]=35"
{
"Organisation": "Organisation name",
"Services": {
"serviceId": {
"1": "25",
"2": "35"
}
}
}
Activate user license for service/s by user id.User id is required in url
Request Method: PUT
Url: https://eftsecure.callpay.com/api/v1/user/$USER_ID/activate
Put parameters: post array of service ids
eg. serviceId[]=$SERVICE_ID_ONE
serviceId[]=$SERVICE_ID_TWO
See available service IDs
curl -X PUT -u validusername:validpassword https://eftsecure.callpay.com/api/v1/user/2/activate -d "serviceId[]=1&serviceId[]=2"
{
"services": {
"service_one": "Activated",
"service_two": "Activated"
},
"User": {
"id": 2,
"name": "4315",
"lastname": "4315",
"email": "4315@yourdomain.co.za",
"username": "4315"
}
}
Deactivate user license for service/s by user id.User id is required in url
Request Method: PUT
Url: https://eftsecure.callpay.com/api/v1/user/$USER_ID/deactivate
Put parameters: post array of service ids
eg. serviceId[]=$SERVICE_ID_ONE
eg. serviceId[]=$SERVICE_ID_TWO
See available service IDs
curl -X PUT -u validusername:validpassword https://eftsecure.callpay.com/api/v1/user/3/deactivate -d "serviceId[]=1&serviceId[]=2"
{
"services": {
"service_one": "Deactivated",
"service_two": "Deactivated"
},
"User": {
"id": 3,
"name": "4315",
"lastname": "4315",
"email": "4315@yourdomain.co.za",
"username": "4315"
}
}