Batch API

We have released a new service that allows our clients to create a batch of requests for Shaype to process.

Payments

Our initial offering for batch processing allows our clients to send a list of payment instructions. The processing of these transactions will be managed by Shaype and outcomes will be provided via our transaction Notification web hooks as normal.

You can create a batch of ACCOUNT_TRANSFER requests using our create a batch API.

Once the batch has completed we will provide a Notification web hook to confirm all records have been attempted. The body of this web hook will provide a count or how many transactions have been ACCEPTED, FAILED or returned an ERROR.

📘

Batch Outcomes

ACCEPTED: The payment was processed successfully and passed authorisation checks. This payment will include a web hook notification for the outcome of the payment.

FAILED: The payment was processed successfully but failed authorisation checks. This payment will include a web hook notification for the outcome of the payment.

ERROR: The payment was unable to be processed. This payment was rejected at the API and would need to be manually reattempted. No web hook notification will be provided as there is no outcome to the authorisation attempt.

We have provided a API to return the granular detail on each transaction.

We have provided an API to return the status of all batches that have been received with a status that reflects if the batch has completed processing.