Authorisation Flow

The Authorise-Capture model is used by some payment methods. For now, AfterPay is the only payment method that uses Authorise-Capture model.

Authorise-Capture flow is initiated by Authorise operation. Create Authorisation endpoint returns authorisation instance which later on is captured and transaction instance is created. After transaction is created, all the transaction operations could be called. Capture could be requested depending on the merchant's business logic. Let's take a retail ecommerce merchant as an example. Capture could be called after merchant ships the items. This means the money is actually debitted from the consumer.

If authorisation is decided to be reverted, then Cancel operation could be requested on authorisation instance. This should be done before any capture call is requested.

Create Authorisation

Initiates a new authorisation and returns authorisation instance with status and id in case the of success. This id could then be used for capture to create transaction or for cancel.

POST /api/contract/authorisations

Capture Authorisation

Initiates transaction flow. This endpoint returns the created transaction with id and status.

POST /api/authorisations/{authorisationId}/capture

Cancel Authorisation

Cancels an authorisation with open status.

POST /api/authorisations/{authorisationId}/cancel