Perform a posting to an account

This operation is asynchronous. It is responded to by the createPostingResponse operation

Scheme	Applicable
ZA_EFT	✓
ZA_RPP	✓
ZA_RTC	✓

Request

header Parameters

traceparent	string (traceparent) ^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]... A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the `traceparent` element defined in the W3C Trace Context Level 2 specification.
tracestate	string (tracestate) ^[A-Za-z0-9=, _\*/@]{0,1024}$ A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the `traceparent` element defined in the W3C Trace Context Level 2 specification.

Request Body schema: application/json

required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
required	object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
aggregatedTransactionCount required	integer A count of how many payments are aggregated into this posting
required	object (Amount)
	object (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
creditorAccountReference	string An explanation of the transaction, e.g. to be printed on the creditor account holder's statement.
	object (InstitutionIdentification)
	object (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
debtorAccountReference	string An explanation of the transaction, e.g. to be printed on the debtor account holder's statement.
	object (InstitutionIdentification)
direction	string (TransactionDirection) Indicates the direction of the original payment, from the perspective of Electrum and the Partner. Enum: "INBOUND" "OUTBOUND" "ON_US"
effectiveDateTime required	string <date-time> The effective action date-time of the posting.
initiationSource	string Free text field used to inform the core banking system of which system is initiating the posting.
	object (LocalInstrumentType)
paymentMethod required	string Specifies the means of payment for the original transaction. Enum: "CreditTransfer" "DirectDebit"
paymentScheme required	string (PaymentSchemeName) Identifies the scheme used for the payment `ZA_RTC`: South African Realtime Clearing scheme `ZA_RPP`: South African Realtime Payments Platform scheme. `ZA_EFT`: South African Electronic Funds Transfer scheme. Enum: "ZA_RTC" "ZA_RPP" "ZA_EFT"
paymentUetr required	string <UUID> UUID which links the posting to a payment instruction.
schema required	string Value: "PostingRequest"

Responses

202

Accepted. RFC9110 - 202

400

Bad request. RFC9110 - 400

401

Unauthorized. RFC9110 - 401

403

Forbidden. RFC9110 - 403

405

Method not allowed. RFC9110 - 405

422

Unprocessable content. RFC9110 - 422

429

Too Many Requests. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/funds-management/posting

Request samples

application/json

{"schema": "PostingRequest",
"messageIdentifiers": {"messageIdentification": "msg-67890",
"creationDateTime": "2025-02-01T10:00:00Z"
},
"transactionIdentifiers": {"endToEndIdentification": "e2e-67890",
"transactionIdentification": "txn-67890",
"uetr": "123e4567-e89b-12d3-a456-426614174000"
},
"paymentUetr": "123e4567-e89b-12d3-a456-426614174000",
"effectiveDateTime": "2025-02-01T10:00:00Z",
"creditorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 987654123
},
"type": {"schema": "CODE",
"value": "CACC"
}
},
"creditorAccountReference": "Creditor Ref",
"creditorAgent": {"bicfi": "RY8PEGJ0",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay"
}
},
"debtorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 123456098
},
"type": {"schema": "CODE",
"value": "CACC"
}
},
"debtorAccountReference": "Debtor Ref",
"debtorAgent": {"bicfi": "BB8PEGJ0",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Cape Town"
}
},
"amount": {"value": 100,
"currency": "ZAR"
},
"aggregatedTransactionCount": 1,
"initiationSource": "EPC Singles",
"paymentScheme": "ZA_EFT",
"localInstrument": {"schema": "CODE",
"value": "CTR"
},
"paymentMethod": "CreditTransfer",
"direction": "OUTBOUND",
"supplementaryData": {"key1": "value1",
"key2": "value2"
}
}

Response samples

application/json

{"detail": "string",
"message": "string",
"schema": "ErrorDetail"
}