Different Payment Authorization Flows

Overview

Lean supports multiple flows for authorising and queueing payments which can be combined so they fit your specific requirements and business flows.

Queueing payments is always done in the same way but authorising Lean provides 4 distinct ways to authorise them from your bank account:

  • Manual Authorisation from the Lean Application Dashboard
  • Manual Authorisation from your Bank Portal (early access feature)
  • Automatic Authorization
  • On Demand Authorization (early access feature)

๐Ÿ“˜

Choosing between Automatic and Manual Payouts

You must set the authorize_paymentto false to use any of the Manual Authorisation flows or the On Demand Authorization flow.

Setting the authorize_payment to true will make the payouts use the Automatic Authorization flow.

Manual Authorization from the Lean Application Dashboard

Your FinOps employees can go on the Application Dashboard and look at all the Pending Payments that require a manual authorization from your side.

The user can select the payments that needs to be authorized, and press on the Authorize button.

๐Ÿ“˜

The user must have already connected their bank credentials.

That action will launch a window prompting the user to provide the OTP code sent to them by the bank (normally in the form of an SMS). Providing the OTP is required otherwise the payments will not be authorised.

After authorizing a single or multiple payouts via the Application Dashboard you will receive web-hooks of type payment.updated reflecting the most up to date status of your payout requests. You will receive one web-hook per payout submitted.

Manual Authorization from your Bank Portal

๐Ÿšง

This is an Early Access feature

Please reach out to your Lean Relationship Manager to discuss enabling this for your account.

Payments queued by Lean via a call to the Create Payouts Payment endpoint will show up on the bank portal as if they were queued by one of your empoyees. Your FinOps team can continue to use the existing Bank Portal to authorize payments.

Lean will periodically check the status only of payment which are queued by us and will update the status to reflect any authorisations done manually from your Bank's portal. You will receive a web-hooks of type payment.updated whenever we detect that a payment has been either successfully or unsuccessfully authorised. Please note: Lean can only update the status to ACCEPTED_BY_BANK, PENDING_WITH_BANK, FAILED. We are not be able to detect AUTHORIZATION_FAILED in this flow.

Automatic Authorization

Payments which are marked with authorize_payment flag set to true will be automatically authorised and you will receive web-hooks of type payment.updated. There is no need for a person to interact with the Lean's Application Dashboard or for your backend to make a call to the Lean Backend APIs.

On Demand Authorization

๐Ÿšง

This is an Early Access feature

Please reach out to your Lean Relationship Manager to discuss enabling this for your account.

Payments which are marked with authorize_payment flag set to false can be authorized via a backend call to Lean and you will receive web-hooks of type payment.updated. There is no need for a person to interact with the Lean Application Dashboard.

Payment Lifecycle

Regardless of the chosen authorization flow, a Payout payment has several statuses (or states) in it's life-cycle:

  • FAILED - the payment has failed to be queued or authorized.
  • AWAITING_AUTHORIZATION - the payment has been successfully queued on the Bank's side.
  • AUTHORIZATION_FAILED - the payment has failed to be authorised. This is a retry-able state.
    • Manual Authorization flow -> You can try to authorize again from the Dashboard
    • Automatic Authorization flow -> Lean will retry to authorize to payment 5 times before moving it to FAILED state
  • PENDING_WITH_BANK - the payment has been successfully authorised but the bank didn't provide us with a reference id. If you receive this status please raise a ticket with Lean to investigate.
  • ACCEPTED_BY_BANK - the payment has been successfully authorised and accepted by the bank.

๐Ÿšง

ACCEPTED_BY_BANK or PENDING_WITH_BANK does not guarantee the payment has been received by the destination account.

Payment Finality is an early access feature. Please reach out to a Lean representative to learn more and would like access to this feature.