Requests that a payment be made towards a customer account.
A payment request
Array of objects (TransactionLabel) A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions. | |
object (Category) Category to which a bill issuer can belong | |
id required | string The randomly generated UUID identifying this transaction, as defined for a variant 4 UUID in RFC 4122 |
time required | string <date-time> The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision |
required | object (Originator) The Originator object encapsulates data relating to the originator of the transaction |
required | object (Institution) Originating, acquiring, processing, or receiving institution details |
object (Institution) Originating, acquiring, processing, or receiving institution details | |
object (Institution) Originating, acquiring, processing, or receiving institution details | |
required | Array of objects (ThirdPartyIdentifier) An array of identifiers which each identify the transaction within each entity's system. |
object (SlipData) Data that may be printed on the customer slip for information purposes | |
basketRef | string Used to group multiple transactions which would otherwise be considered independent. |
tranType | string Data relating to the type of transaction taking place (i.e. cash withdrawal, goods and services etc.). |
srcAccType | string This specifies the type of source account being used in the transaction (i.e. cheque, savings). |
destAccType | string This specifies the type of destination account being used in the transaction (i.e. cheque, savings). |
stan | string The System Trace Audit Number can be used to locate transactions across different systems. |
rrn | string This is a reference set by the original source of the transaction. |
object (Customer) A bill payment customer | |
accountRef required | string [ 6 .. 40 ] characters A reference number identifying the bill payments processor, bill issuer, and customer |
required | object (BillpayAmounts) Amounts which make up the transaction. Absent amounts have zero value. |
Array of objects (Tender) Contains the tenders for the payment request if available | |
Array of objects (PaymentMethod) Contains the payment method for the payment request if available | |
lookupId | string The UUID identifying the lookup that this request relates to |
Created
Bad request
Internal server error
Service unavailable
Gateway timeout
{- "transactionLabels": [
- {
- "name": "string",
- "value": "string"
}
], - "selectedCategory": {
- "id": "string",
- "name": "string"
}, - "id": "string",
- "time": "2019-08-24T14:15:22Z",
- "originator": {
- "institution": {
- "id": "string",
- "name": "string"
}, - "terminalId": "stringst",
- "merchant": {
- "merchantType": "string",
- "merchantId": "stringstringstr",
- "merchantName": {
- "name": "string",
- "city": "string",
- "region": "st",
- "country": "st"
}
}, - "operatorId": "string",
- "channelId": "string"
}, - "client": {
- "id": "string",
- "name": "string"
}, - "settlementEntity": {
- "id": "string",
- "name": "string"
}, - "receiver": {
- "id": "string",
- "name": "string"
}, - "thirdPartyIdentifiers": [
- {
- "institutionId": "string",
- "transactionIdentifier": "string"
}
], - "slipData": {
- "messageLines": [
- {
- "barcode": {
- "data": "string",
- "encoding": "string"
}, - "text": "string",
- "fontWidthScaleFactor": 0,
- "fontHeightScaleFactor": 0,
- "line": false,
- "cut": false
}
], - "slipWidth": 0,
- "issuerReference": "string"
}, - "basketRef": "string",
- "tranType": "GOODS_AND_SERVICES",
- "srcAccType": "DEFAULT",
- "destAccType": "DEFAULT",
- "stan": "string",
- "rrn": "string",
- "customer": {
- "firstName": "string",
- "lastName": "string",
- "address": "string",
- "idNumber": "string",
- "contactNumber": "string"
}, - "accountRef": "string",
- "amounts": {
- "requestAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "approvedAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "feeAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "balanceAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "additionalAmounts": {
- "property1": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "property2": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}
}, - "maxPayableAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "minPayableAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}
}, - "tenders": [
- {
- "accountType": "DEFAULT",
- "amount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "cardNumber": "string",
- "reference": "string",
- "tenderType": "CASH"
}
], - "paymentMethods": [
- {
- "type": "AN_32_TOKEN",
- "name": "string",
- "amount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "issuer": {
- "id": "string",
- "name": "string"
}, - "pin": {
- "type": "CLEAR_PIN"
}, - "proxy": "string",
- "proxyType": "MSISDN"
}
], - "lookupId": "string"
}
{- "transactionLabels": [
- {
- "name": "string",
- "value": "string"
}
], - "id": "string",
- "time": "2019-08-24T14:15:22Z",
- "originator": {
- "institution": {
- "id": "string",
- "name": "string"
}, - "terminalId": "stringst",
- "merchant": {
- "merchantType": "string",
- "merchantId": "stringstringstr",
- "merchantName": {
- "name": "string",
- "city": "string",
- "region": "st",
- "country": "st"
}
}, - "operatorId": "string",
- "channelId": "string"
}, - "client": {
- "id": "string",
- "name": "string"
}, - "settlementEntity": {
- "id": "string",
- "name": "string"
}, - "receiver": {
- "id": "string",
- "name": "string"
}, - "thirdPartyIdentifiers": [
- {
- "institutionId": "string",
- "transactionIdentifier": "string"
}
], - "slipData": {
- "messageLines": [
- {
- "barcode": {
- "data": "string",
- "encoding": "string"
}, - "text": "string",
- "fontWidthScaleFactor": 0,
- "fontHeightScaleFactor": 0,
- "line": false,
- "cut": false
}
], - "slipWidth": 0,
- "issuerReference": "string",
- "phoneNumber": "string"
}, - "basketRef": "string",
- "tranType": "GOODS_AND_SERVICES",
- "srcAccType": "DEFAULT",
- "destAccType": "DEFAULT",
- "stan": "string",
- "rrn": "string",
- "customer": {
- "firstName": "string",
- "lastName": "string",
- "address": "string",
- "idNumber": "string",
- "contactNumber": "string"
}, - "amounts": {
- "requestAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "approvedAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "feeAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "balanceAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "additionalAmounts": {
- "property1": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "property2": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}
}, - "maxPayableAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "minPayableAmount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}
}, - "partPaymentAllowed": false,
- "overPaymentAllowed": false,
- "account": {
- "accountRef": "string",
- "dueDate": "2019-08-24"
}, - "tenders": [
- {
- "accountType": "DEFAULT",
- "amount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "cardNumber": "string",
- "reference": "string",
- "tenderType": "CASH"
}
], - "paymentMethods": [
- {
- "type": "AN_32_TOKEN",
- "name": "string",
- "amount": {
- "amount": 0,
- "currency": "string",
- "ledgerIndicator": "DEBIT"
}, - "issuer": {
- "id": "string",
- "name": "string"
}, - "pin": {
- "type": "CLEAR_PIN"
}, - "proxy": "string",
- "proxyType": "MSISDN"
}
]
}