get https://sandbox.interswitchng.com/arbiter/api/v1/transactions/groups
Use this to get all available transaction groups. Each transaction group contains the list of channels
REQUEST
| Field Name | Description | Type | Required | Constraints |
|---|---|---|---|---|
| pageNum | The number of the page to start from | Integer | Optional | Default: 1 |
| pageSize | The number of items returned per page | Integer | Optional | Default: 100. Max: 100 |
Sample Request
{{base_url}}/api/v1/transactions/groups
{{base_url}} is the location of arbiter 2.0 API
RESPONSE
| Field Name | Description | Type |
|---|---|---|
| name | Name of the group | String |
| channels | An array of channels available on the transaction group | JSON Array |
| customerReference | Reference used by the transaction store to identify the transaction | String |
| store | Name of the transaction store the group belongs to | String |
| requiredParameters | List of parameters required when searching for a transaction within the group | JSON Array |
| additionalParameters | List of optional parameters when searching for a transaction. | JSON Array |
Sample Response
[
{
"name": "AGENCY BANKING",
"channels": {
"ALL": {
"customerReference": "pan",
"store": "RJService",
"requiredParameters": [
"terminal",
"pan"
],
"additionalParameters": [
"stan",
"account",
"rrn "
]
}
}
},
{
"name": "Bill Payment",
"channels": {
"All": {
"customerReference": "customerReference",
"store": "PAYDIRECT",
"requiredParameters": [],
"additionalParameters": [
"phoneNumber",
"paymentReference",
"pan"
]
}
}
},
{
"name": "CASH WITHDRAWAL",
"channels": {
"ALL": {
"customerReference": "pan",
"store": "RJService",
"requiredParameters": [
"terminal",
"pan"
],
"additionalParameters": [
"stan",
"account",
"rrn "
]
}
}
},
{
"name": "IPG",
"channels": {
"All": {
"customerReference": "customerReference",
"store": "IPG",
"requiredParameters": [
"transactionReference"
],
"additionalParameters": [
"merchantCode",
"maskedPan",
"stan",
"retrievalReferenceNumber"
]
}
}
},
{
"name": "PURCHASE",
"channels": {
"ALL": {
"customerReference": "pan",
"store": "RJService",
"requiredParameters": [
"terminal",
"pan"
],
"additionalParameters": [
"stan",
"account",
"rrn"
]
}
}
},
{
"name": "PayCode",
"channels": {
"All": {
"customerReference": "subscriberPhoneNumber",
"store": "PAYDIRECT",
"requiredParameters": [],
"additionalParameters": [
"paycode",
"amount",
"beneficiaryPhoneNumber"
]
}
}
},
{
"name": "TRANSFERS ",
"channels": {
"ALL": {
"customerReference": "pan",
"store": "RJService",
"requiredParameters": [
"terminal",
"pan"
],
"additionalParameters": [
"stan",
"account",
"rrn "
]
}
}
},
{
"name": "Transfer Service",
"channels": {
"All": {
"customerReference": "sourceAccountNumber",
"store": "TRANSFERSERVICE",
"requiredParameters": [],
"additionalParameters": [
"transactionReference",
"clientReference",
"destinationInstitutionDomainCode",
"destinationAccountNumber",
"sourceInstitutionDomainCode",
"sourceAccountNumber"
]
}
}
},
{
"name": "Visa RJ",
"channels": {
"ALL": {
"customerReference": "pan",
"store": "RJService",
"requiredParameters": [
"terminal",
"pan"
],
"additionalParameters": [
"stan",
"account",
"rrn"
]
}
}
}
]