Message Payload Samples
AccountLookupRequest
Path: billpay/v4/accountLookups/{requestId}
HTTP method: POST{
"id":"291d3823-bdf3-4e45-b32b-11a58188033e",
"time":"2020-10-01T22:01:50.304Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"receiver":{
"id":"63294302",
"name":"MultiChoice DStv"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"accountRef":"1234567890123"
}AccountLookupResponse
Path: billpay/v4/accountLookups/{requestId}
HTTP status: Success{
"id":"291d3823-bdf3-4e45-b32b-11a58188033e",
"time":"2020-10-01T22:01:50.304Z",
"originator":{
"institution":{
"id":"1234567",
"name":" Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":" Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":" Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"Easypay"
},
"receiver":{
"id":"4444",
"name":"MultiChoice"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"slipData":{
"messageLines":[
],
"slipWidth":0
},
"amounts":{
"minPayableAmount":{
"amount":39916,
"currency":"710",
"ledgerIndicator":"DEBIT"
}
},
"partPaymentAllowed":true,
"overPaymentAllowed":true,
"account":{
"accountRef":"1234567890123"
}
}PaymentRequest
Path: billpay/v4/payments/{paymentId}
HTTP method: POST{
"id":"dc892da4-5215-4297-9756-050d82292a7e",
"time":"2020-10-01T20:02:14.732Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"Easypay"
},
"receiver":{
"id":"63294302",
"name":"MultiChoice DStv"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"accountRef":"1234567890123",
"amounts":{
"requestAmount":{
"amount":50000,
"currency":"710"
}
},
"tenders":[
{
"accountType":"DEFAULT",
"amount":{
"amount":50000,
"currency":"710"
},
"tenderType":"OTHER"
}
],
"paymentMethods":[
]
}PaymentResponse
Path: billpay/v4/payments/{paymentId}
HTTP status: Created{
"id":"dc892da4-5215-4297-9756-050d82292a7e",
"time":"2020-10-01T20:02:14.732Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"Easypay"
},
"receiver":{
"id":"63294302",
"name":"MultiChoice DStv"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"accountRef":"1234567890123",
"amounts":{
"requestAmount":{
"amount":50000,
"currency":"710"
}
},
"tenders":[
{
"accountType":"DEFAULT",
"amount":{
"amount":50000,
"currency":"710"
},
"tenderType":"OTHER"
}
],
"paymentMethods":[
]
}TenderAdvice
Path: billpay/v4/payments/{paymentId}/confirmations/{adviceId}
HTTP method: POST{
"id":"29227d87-a607-45e1-874f-19db456c65bd",
"requestId":"dc892da4-5215-4297-9756-050d82292a7e",
"time":"2020-09-02T20:02:31.039Z",
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"tenders":[
{
"accountType":"DEFAULT",
"amount":{
"amount":50000,
"currency":"710"
},
"tenderType":"OTHER"
}
]
}BasicAdviceResponse
Path: billpay/v4/payments/{paymentId}/confirmations/{adviceId}
HTTP status: Accepted{
"id":"29227d87-a607-45e1-874f-19db456c65bd",
"requestId":"dc892da4-5215-4297-9756-050d82292a7e",
"time":"2020-09-02T20:02:31.039Z",
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"tenders":[
{
"accountType":"DEFAULT",
"amount":{
"amount":50000,
"currency":"710"
},
"tenderType":"OTHER"
}
]
}BasicReversal
Operation: billpay/v4/payments/{paymentId}/reversals/{adviceId}
Http Method: POST{
"id":"cfc4e6ca-ebde-4a86-9212-0982e2169623",
"requestId":"82deb559-f610-4945-be12-9a7a0a1a7085",
"time":"2020-09-28T14:28:04.719Z",
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"reversalReason":"CANCELLED"
}ErrorDetail
{
"errorType":"FORMAT_ERROR",
"errorMessage":"Notice number invalid",
"requestType":"TRAFFIC_FINE_LOOKUP_REQUEST",
"id":"a83f7d41-d395-4b3e-83b5-6f2f8bb25745"
}TrafficFineLookupRequest
Path: billpay/v4/accountLookups/traffic/{requestId}
HTTP method: POST{
"id":"291d3823-bdf3-4e45-b32b-11a58188033e",
"time":"2020-10-01T22:01:50.304Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"receiver":{
"id":"63294302",
"name":"Department of Traffic"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"noticeNumber":"1234567890123"
}TrafficFineLookupResponse
Path: billpay/v4/accountLookups/traffic/{requestId}
HTTP status: Success{
"id":"291d3823-bdf3-4e45-b32b-11a58188033e",
"time":"2020-10-01T22:01:50.304Z",
"originator":{
"institution":{
"id":"1234567",
"name":" Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":" Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":" Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"Easypay"
},
"receiver":{
"id":"4444",
"name":"Department of Traffic"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"slipData":{
"messageLines":[
],
"slipWidth":0
},
"amounts":{
"minPayableAmount":{
"amount":500,
"currency":"710",
"ledgerIndicator":"DEBIT"
}
},
"partPaymentAllowed":true,
"overPaymentAllowed":true,
"trafficFine":{
"noticeNumber":"1234567890123"
}
}TrafficFinePaymentRequest
Path: billpay/v4/payments/traffic/{paymentId}
HTTP method: POST{
"id":"dc892da4-5215-4297-9756-050d82292a7e",
"time":"2020-10-01T20:02:14.732Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"Traffic Dept."
},
"receiver":{
"id":"63294302",
"name":"Gallows Hill traffic dept."
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"noticeNumber":"1234567890123",
"amounts":{
"requestAmount":{
"amount":700,
"currency":"710"
}
},
"tenders":[
{
"accountType":"DEFAULT",
"amount":{
"amount":700,
"currency":"710"
},
"tenderType":"OTHER"
}
],
"paymentMethods":[
]
}TrafficFinePaymentResponse
Path: billpay/v4/payments/traffic/{paymentId}
HTTP status: Created{
"id":" dc892da4-5215-4297-9756-050d82292a7e",
"time":"2020-10-01T20:02:14.732Z",
"originator":{
"institution":{
"id":"1234567",
"name":"Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"Traffic Dept."
},
"receiver":{
"id":"4444",
"name":"Gallows Hill traffic dept."
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
},
{
"institutionId":"6329431",
"transactionIdentifier":"01234567899"
}
],
"slipData":{
"messageLines":[
],
"slipWidth":0,
"issuerReference":"5902021205085"
},
"amounts":{
"approvedAmount":{
"amount":700,
"currency":"710",
"ledgerIndicator":"DEBIT"
}
},
"partPaymentAllowed":true,
"overPaymentAllowed":true,
"trafficFine":{
"noticeNumber":"1234567890123"
},
"tenders":[
{
"accountType":"DEFAULT",
"amount":{
"amount":700,
"currency":"710"
},
"tenderType":"OTHER"
}
],
"paymentMethods":[
]
}RefundRequest
Path: billpay/v4/refunds/{refundId}
HTTP method: POST{
"id":"2e6edf63-b30a-4e53-9fd5-bda804b6f8ba",
"time":"2021-04-29T12:17:34.000Z",
"originator":{
"institution":{
"id":"1234567",
"name":" Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
}
],
"issuerReference":"01234567890",
"refundReason":"Damaged"
}RefundResponse
Path: billpay/v4/refunds/{refundId}
HTTP status: Created{
"id":"2e6edf63-b30a-4e53-9fd5-bda804b6f8ba",
"time":"2021-04-29T12:17:34.000Z",
"originator":{
"institution":{
"id":"1234567",
"name":" Originating system"
},
"terminalId":"00000001",
"merchant":{
"merchantType":"5411",
"merchantId":"00123456789001234",
"merchantName":{
"name":"Originating system",
"city":"Cape Town",
"region":"WC",
"country":"ZA"
}
}
},
"client":{
"id":"1234567",
"name":"Originating system"
},
"settlementEntity":{
"id":"6329431",
"name":"EasyPay"
},
"receiver":{
"id":"4444",
"name":"CityofJoburg"
},
"thirdPartyIdentifiers":[
{
"institutionId":"1234567",
"transactionIdentifier":"123456789012"
},
{
"institutionId":"6329431",
"transactionIdentifier":"01234567890"
}
],
"slipData":{
"messageLines":[
],
"slipWidth":0
},
"partPaymentAllowed":true,
"overPaymentAllowed":true,
"account":{
"accountRef":"012345678912345"
}
}