This chapter includes information about features or aspects of the platform that are deemed Early Access.
Early Access features has added stability and will not encounter breaking changes, offering a backward compatible API Schema.
Certain Early Access features may not be accessible to all Stitch users by default. These features can be enabled on a per-client basis on request.
A settlement represents a payout made to a client and contains a batched set of user payments.
For test clients mock settlements are created once a day and include all completed payments for the previous day.
- Settlements are currently only available to South African customers.
- A Stitch settlement account is required.
Please contact firstname.lastname@example.org for more information on these.
The following table outlines the possible statuses of a settlement:
|Payment has been completed by the user, but the settlement has not yet been submitted.|
|The settlement has been submitted to the bank, but confirmation of completion has not been received yet.|
|The settlement has been submitted to the bank, and confirmation of completion has been received.|
|Failed to pay settlement into destination account.|
SettlementFailed status indicates that the settlement has failed and has an associated
settlementFailedReason. Examples of settlement failure reasons are listed below.
|The settlement was submitted to the bank but was not completed.|
|This settlement has failed due to having insufficient funds in the settlement account. Please contact email@example.com to resolve.|
|The provided client account is invalid.|
|An unknown error has occurred processing the settlement into the provided client account.|
To view the collection of settlements and associated LinkPay payment initiations, you may query the
Client.settlements field on the API. This will return a paged collection of settlements, dated from most recent to least.
Similarly to query the InstantPay payment initiation requests associated with a settlement you can select the
paymentInitiationRequests on the settlements field.
Using the query below you can retrieve the status of a specific settlement and any associated payment initiations or payment initiation requests.
When retrieving a payment initiation or payment initiation request, the associated settlement can be added to the node.
For clients without a Stitch intermediary account, or paymentRequests that have not been completed, the settlement will be