Receive the response to an outbound bulk request to pay

This operation is asynchronous. It starts with the outboundBulkRequestToPay operation orgetOutboundBulkRequestToPayStatus operation

Communicates the bulk status of a prior bulk request to pay.

An outboundBulkRequestToPayResponse contains the information indicating the state of the bulk as a whole and the status of the individual request to pay transactions

If the partner is unsure of the status of an outboundBulkRequestToPay, an getOutboundBulkRequestToPayStatus may be used to solicit an up-to-date outboundBulkRequestToPayResponse.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
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 (V2))[https://www.w3.org/TR/trace-context-2/].
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 (V2))[https://www.w3.org/TR/trace-context-2/].

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 (SupplementaryData) A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
bulkPaymentSchemeName 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"
numberOfTransactions	integer >= 1 The total amount of transactions in the bulk.
requestToPayInformationId required	string <UUID> Universally unique identifier to identify the bulk collection itself.
required	object (InitiationStatus)
	Array of objects (RequestToPayInstructionStatusReport) >= 0 characters List of RequestToPayInstructionStatusReports relating to each request to pay initiation instruction received and actioned. Unsubmitted transactions will not be in this list.
schema required	string Value: "RequestToPayInitiationStatusRequest"
required	object (RequestToPayTransactionStatistics) A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.

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/transactions/outbound/bulk/request-to-pay-response

Request samples

application/json

{"schema": "RequestToPayInitiationResponse",
"requestToPayInformationId": "6e831b77-3e51-4a0e-a818-dc99a08f80d4",
"messageIdentifiers": {"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2024-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2024-05-04T03:02:01Z"
},
"bulkPaymentSchemeName": "ZA_RPP",
"requestToPayInitiationStatus": {"outcome": "COMPLETED",
"reasonInfo": [{"reason": {"schema": "CODE",
"value": "ACSC"
},
"additionalInformation": "Settlement completed on debtor account"
}
]
},
"transactionStatistics": {"numberOfPaidTransactions": 2,
"numberOfAcceptedTransactions": 2,
"numberOfCancelledTransactions": 0,
"numberOfExpiredTransactions": 0,
"numberOfPendingTransactions": 0,
"numberOfPresentedTransactions": 0,
"numberOfRejectedTransactions": 0,
"numberOfUnsubmittedTransactions": 0
},
"numberOfTransactions": 2,
"requestToPayInstructionStatusReports": [{"status": {"status": "CANCELLED",
"reasonInfo": [{"reason": {"schema": "CODE",
"value": "CUST"
},
"additionalInformation": "Cancellation requested by the Creditor"
}
]
},
"originalRequestToPayData": {"creditor": {"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": "90001236549870",
"scheme": {"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"creditorAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"amounts": {"bankSettlementAmount": {"value": 100,
"currency": "ZAR"
}
},
"remittanceInformation": {"unstructured": ["some",
"unstructured",
"information"
],
"structured": [{"creditorReference": {"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": ["Some",
"Additional",
"Information"
]
}
]
},
"debtor": {"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {"schema": "PERSON",
"identifiers": [{"identification": "90001236549870",
"scheme": {"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"debtorAgent": {"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": ["16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"expiryDateTime": "2024-04-09T09:32:51.395+02:00",
"paymentTypeInformation": {"localInstrument": {"schema": "PROPRIETARY",
"value": "PBPX"
}
}
},
"transactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
}
}
]
}

Response samples

application/json

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