Skip to main content

Confirm & Authorise a Payment Run

Enable your customers to confirm the payment run details and authorise the supplier payments.

Confirm a payment run​

Once a payment run is created and it's status is PENDING_CONFIRMATION, a Controller user is able to confirm the payment run. By confirming the payment run, the Controller is taking responsibility that the details within the run are correct.

POST/payment_runs/{id}/confirmTry it

The API endpoint will return the payment run with a VERIFYING_REQUIREMENTS status. If you are subscribed and watching the payment run events you will also receive an event with the status update.

info

The VERIFYING_REQUIREMENTS status is a transitory status and once Weavr completes all checks, the payment run status will transition to PENDING_FUNDING or PENDING_CHALLENGE status for which an event will also be sent to you.

Authorise a payment run​

If the payment run transitioned to a PENDING_CHALLENGE status, that means that the Controller needs to complete SCA to further authorise the run. Payments won't be executed before this step is completed successfully.

Pre-requisites

To complete a Payment Run authorisation, the user must:

Authorisation Secure UI Component​

You can trigger the Payment Run authorisation process by embedding the Payment Run Authorisation Secure UI component. The Secure UI component will show an overview of the Payment Run, along with the list of payments in the run to the logged-in user and then trigger an SCA challenge.

By completing the SCA challenge, the Controller is taking responsibility that the company wants to execute the payments listed in the run. The OTP challenge expire after 5 minutes of inactivity., if the challenge exceeds 5 minutes or the user clicks on Decline the component will trigger a decline event which should be handled by the application.

Supported SCA channels

Payment run at the moment supports OTP via SMS as the channel to complete SCA. Other channels such as Biometrics will be added soon.

As soon as this step is completed, the payment run status will transition to:

  • PENDING_FUNDS if the SCA is successfully. Learn how to fund a payment run by reading the guide.
  • INVALID if the SCA failed.
SCA retries

The Controller can retry SCA for up to 3 times. After which the payment run status will transition to a finite INVALID state.

If the Controller still wishes the execute the payments, a new payment run needs to be created.