API Reference Docs
API v1ChangelogAPI Status
Start typing to search…

Initiate Pay by Bank

post
https://sandbox-api.lemonway.fr/mb/ENV-NAME/directkitrest/v2/moneyins/paybybank/transfer/init

How does it work?

1. Call POST v2/moneyins/paybybank/transfer/init, to receive a redirect URL and the transaction Id.

2. Redirect the end-user to your bank selection page, were they can select their bank from the displayed list.

Note: If you specify the bankId in the request body, the end-user will be directed to their bank.
For further information on how to obtain bankIds, see: /v2/moneyins/ paybybank/transfer/banks 3. Once the end-user selects their bank they are redirected to the bank webpage to enter their credentials.

Note: If you have previously specified the bankId the end-user only needs to enter their bank credentials at this stage.

4. After successfully entering their credentials, the end-user will go through Strong Customer Authentication (SCA) to confirm their identity (SCA examples include: face recognition or mobile Bank App software). Some bank ask to SCA before entering credentials.

5. Once successfully authenticated the end-user only needs to verify and validate the amount, comments and so forth on the bank website.

6. After submitting the payment, the end-user will be redirected to:
  • returnUrl in case of success
  • cancelUrl in case of cancellation
  • errorUrl in case of error.
These 3 URLs must be publicly accessible for the end-user. It must also be accessible to our WebKit server to send requests to the end-user.

Initiate a Pay‑by‑Bank transfer with POST /v2/moneyins/paybybank/transfer/init to receive:

  • redirectUrl: Where to send the end‑user for bank selection/authorization
  • transactionId: Unique identifier for the transfer

Flow:

  1. Initialization:

    • Call POST /v2/moneyins/paybybank/transfer/init.

    • Transfert type: Indicate if the bank transfer isclassic or instant
      • classic : standard SEPA credit transfer. Funds are credited in 2–3 business days.
      • instant : faster SEPA instant transfer. Funds are credited within 15 minutes if supported by the payer’s bank.

  2. Bank Selection:

    • If no bankId was provided, redirect the user to the bank selection page.

  3. Authentication & SCA:

    • The user logs in to their chosen bank.
    • They complete Strong Customer Authentication (e.g., fingerprint, app challenge).

  4. Payment Review:

    • The user confirms amount, reference, etc., on the bank’s site.

  5. Redirect Back:

    • On success → returnUrl
    • On cancellation → cancelUrl
    • On error → errorUrl

Note: All callback URLs must be publicly accessible and reachable by Lemonway’s WebKit.

Important: Whenever you see accountId in a path or body parameter, enter your wallet’s ID.

Language
Click Try It! to start a request and see the response here!