createAccountPayment

Requests that a payment be made towards a customer account.

SecurityhttpBasic or oauth2
Request
path Parameters
paymentId
required
string

The randomly generated UUID of this request

Request Body schema: application/json

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.).

Enum: "GOODS_AND_SERVICES" "CASH_WITHDRAWAL" "DEBIT_ADJUSTMENT" "GOODS_AND_SERVICES_WITH_CASH_BACK" "NON_CASH" "RETURNS" "DEPOSIT" "CREDIT_ADJUSTMENT" "GENERAL_CREDIT" "AVAILABLE_FUNDS_INQUIRY" "BALANCE_INQUIRY" "GENERAL_INQUIRY" "CARD_VERIFICATION_INQUIRY" "CARDHOLDER_ACCOUNTS_TRANSFER" "GENERAL_TRANSFER" "PAYMENT_FROM_ACCOUNT" "GENERAL_PAYMENT" "PAYMENT_TO_ACCOUNT" "PAYMENT_FROM_ACCOUNT_TO_ACCOUNT" "PLACE_HOLD_ON_CARD" "GENERAL_ADMIN" "CHANGE_PIN" "CARD_HOLDER_INQUIRY" "POINTS_INQUIRY"
srcAccType
string

This specifies the type of source account being used in the transaction (i.e. cheque, savings).

Enum: "DEFAULT" "SAVINGS" "CHEQUE" "CREDIT" "UNIVERSAL" "ELECTRONIC_PURSE" "GIFT_CARD" "STORED_VALUE"
destAccType
string

This specifies the type of destination account being used in the transaction (i.e. cheque, savings).

Enum: "DEFAULT" "SAVINGS" "CHEQUE" "CREDIT" "UNIVERSAL" "ELECTRONIC_PURSE" "GIFT_CARD" "STORED_VALUE"
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

Responses
201

Created

400

Bad request

500

Internal server error

503

Service unavailable

504

Gateway timeout

post/payments/{paymentId}
Request samples
application/json
{
  • "transactionLabels": [
    ],
  • "selectedCategory": {
    },
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "originator": {
    },
  • "client": {
    },
  • "settlementEntity": {
    },
  • "receiver": {
    },
  • "thirdPartyIdentifiers": [
    ],
  • "slipData": {
    },
  • "basketRef": "string",
  • "tranType": "GOODS_AND_SERVICES",
  • "srcAccType": "DEFAULT",
  • "destAccType": "DEFAULT",
  • "stan": "string",
  • "rrn": "string",
  • "customer": {
    },
  • "accountRef": "string",
  • "amounts": {
    },
  • "tenders": [
    ],
  • "paymentMethods": [
    ],
  • "lookupId": "string"
}
Response samples
application/json
{
  • "transactionLabels": [
    ],
  • "id": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "originator": {
    },
  • "client": {
    },
  • "settlementEntity": {
    },
  • "receiver": {
    },
  • "thirdPartyIdentifiers": [
    ],
  • "slipData": {
    },
  • "basketRef": "string",
  • "tranType": "GOODS_AND_SERVICES",
  • "srcAccType": "DEFAULT",
  • "destAccType": "DEFAULT",
  • "stan": "string",
  • "rrn": "string",
  • "customer": {
    },
  • "amounts": {
    },
  • "partPaymentAllowed": false,
  • "overPaymentAllowed": false,
  • "account": {
    },
  • "tenders": [
    ],
  • "paymentMethods": [
    ]
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2022. All right reserved.