Initiate Pay by Bank

How does it work?

  1. Call POST /v2/moneyins/paybybank/transfer/init to receive:

    • A redirect URL
    • The transaction ID
  2. Redirect the end user to the bank-selection page, where they can select their bank from the displayed list.

    Note: If you include the bankId in the request body, the end user is redirected directly to their bank.

    To retrieve the available bank IDs, call:

    GET /v2/moneyins/paybybank/transfer/banks

  3. After selecting their bank, the end user is redirected to the bank's website or application to enter their credentials.

    Note: If the bankId was included in the initial request, the end user does not need to select their bank and can proceed directly to authentication.

  4. The end user completes Strong Customer Authentication (SCA) to confirm their identity.

    Authentication methods may include:

    • Facial recognition
    • Fingerprint recognition
    • Confirmation through the bank's mobile application
    • A one-time password

    Depending on the bank, SCA may be requested before or after the end user enters their credentials.

  5. Once authenticated, the end user reviews and confirms the payment details, including the amount and payment reference, on the bank's website or application.

  6. After the payment is submitted, the end user is redirected to one of the following URLs:

    • returnUrl if the payment is successfully submitted
    • cancelUrl if the end user cancels the payment
    • errorUrl if an error occurs

Important: The returnUrl, cancelUrl, and errorUrl must be publicly accessible to both the end user's browser and Lemonway's WebKit servers.


Body Params
string

returnUrl in case of success

string

cancelUrl in case of cancellation

string

errorUrl in case of error

string
required

The country code associated with the payment bank. ISO Alpha-2 codes accepted: (FR) France, (ES) Spain, (IT) Italy, (DE) Germany, and (PT) Portugal

string

If you use the bankId in the call, the end-user will be redirected to their bank. They will not have to select a bank from a list provided. To get a comprehensive list of bankIds call the GET v2/moneyins/paybybank/transfer/banks specifying the ISO Alpha-2 Country Code for example FR for France.

int32
enum

The type of bank transfer, this field is optional. If not provided, the default value is 'Classic'.
The 'TransferType' can be set to two different values:

  • 'Classic': Represents a classic bank transfer with a processing time.
    0 = Undefined.
    1 = Instant.
    2 = Classic.
Allowed:
string
length between 0 and 50

Unique ID of the call, generated by your server. This ID can be used as a search field when looking for operation details

string
required
length between 0 and 256

Payment Account ID to Credit

int32
required

Amount to Debit
Amounts are given as integer numbers in cents

int32

Your Fee
Amounts are given as integer numbers in cents

string
length between 0 and 140

Comment Regarding the Transaction

boolean

If true:

  1. [amountCom] will be ignored and will be replaced with Lemonway's fee
  2. You will not receive any fee
Headers
string
required

Authorization bearer (OAuth 2)

string

Response language accepted by final client (PSU). English by default

string
required

IP address of the final client (PSU).

string

User-agent of the final client (PSU).

Responses

401

Unauthorized

500

InternalServerError

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json