Skip to main content

DebiCheck

caution

This chapter includes information about features or aspects of the platform that are still in Technical Preview.

Features still in Technical Preview may lack significant production stability and are subject to API changes without notice, including breaking API schema changes.

Please do not use a feature in Technical Preview in production without first consulting a support engineer.

Certain Technical Preview features may not be accessible to all Stitch users by default. These features can be enabled on a per client basis on request.

DebiCheck is a seamless way for you to collect funds from your customers on a recurring basis. DebiCheck facilitates the fund collection process by initiating a mandate between you and your customer and then subsequently collecting on that mandate. The agreement is between you and your customer for a subscription service and will be facilitated and maintained via the Stitch API.

The DebiCheck process involves two aspects:

  • mandate initiation with the ability to amend a mandate,
  • and collection against the authorised mandate.

Mandate Initiation​

Mandate initiation is the contract that indicates an authorised agreement between you and your customer. Upon initiating a mandate, you will be required to provide mandate information and the customer will be prompted to authorise the mandate. Once a mandate is successfully initiated you will receive a mandate ID to use to initiate fund collection.

The below diagram depicts mandate initiation via the StitchAPI. The outcome of the mandate initiation is a mandate ID to invoke future collections against.

sequenceDiagram participant Client participant Customer participant StitchAPI Client->>+StitchAPI: create mandate StitchAPI->>+StitchAPI: validate input alt is valid StitchAPI-->>+Client: redirectUri Client->>+Customer: redirectUri invoked to authorise mandate Customer->>+StitchAPI: confirm mandate details and authorise mandate StitchAPI->>+StitchAPI: initiate mandate StitchAPI->>+Customer: authorise mandate via MFA Customer-->>-StitchAPI: mandate authorised StitchAPI-->>-StitchAPI: mandate authorised, return mandate ID StitchAPI-->>-Client: mandate ID else is not valid StitchAPI-->>-Client: validation error end

Mandate Amendment​

In addition to mandate initiation, the Stitch API offers the ability to amend a mandate in the case that the mandate changes. Mandate amendment would involve either updating the existing mandate terms or cancelling the mandate. Your customer will need to reauthorise the mandate in all cases.

sequenceDiagram participant Client participant Customer participant StitchAPI Client->>+StitchAPI: amend mandate StitchAPI->>+StitchAPI: validate input alt is valid StitchAPI-->>+Client: redirectUri Client->>+Customer: redirectUri invoked to authorise mandate amendment Customer->>+StitchAPI: confirm mandate details and authorise mandate StitchAPI-->>-Client: mandate authorised, return mandate ID else is not valid StitchAPI-->>-Client: validation error end

Collections​

With an authorised mandate, you are able to collect funds from you customer via the Stitch API. Collections ensures that you are able to retrieve money from your customer for the agreed subscription, at the agreed upon cadence for the value stipulated during mandate initiation.

Collections can be initiated via the Stitch API as a single collection where details of a single collection against a single mandate are provide or as a batched collection where you provide a batch of collections to process.

note
  • The collections issued have to abide by the mandate that was authorised.
  • If collection does not abide by the original mandate and is successfully, disputes can be raised by the customer and would likely be processed due to the collection being in breach of the mandate :::