MoneyIns | Pay by Bank

Initiate Pay by Bank

<b>How does it work?</b> <br />

<p></p> 1. Call POST v2/moneyins/paybybank/transfer/init, to receive a redirect URL and the transaction Id. <br /><p></p> 2. Redirect the end-user to your bank selection page, were they can select their bank from the displayed list. <br /><p></p><b>Note:</b> If you specify the bankId in the request body, the end-user will be directed to their bank. <br /> 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. <p></p><b>Note:</b> If you have previously specified the bankId the end-user only needs to enter their bank credentials at this stage. <br /><p></p> 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.<br /><p></p> 5. Once successfully authenticated the end-user only needs to verify and validate the amount, comments and so forth on the bank website. <p></p> 6. After submitting the payment, the end-user will be redirected to: <ul><li>returnUrl in case of success</li><li>cancelUrl in case of cancellation</li><li>errorUrl in case of error.</li></ul> 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.
post/v2/moneyins/paybybank/transfer/init

Request

  • Base URL
    https://ws.lemonway.fr/mb/env-name/prod/directkitrest
  • URL
    https://ws.lemonway.fr/mb/env-name/prod/directkitrest/v2/moneyins/paybybank/transfer/init
  • Auth
    none declared. Required headers: Authorization, PSU-IP-Address

Headers

Authorizationstring required

Authorization bearer (OAuth 2)

PSU-Accept-Languagestring

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

PSU-IP-Addressstring required

IP address of the final client (PSU).

PSU-User-Agentstring

User-agent of the final client (PSU).

Request body

returnUrlstring required

returnUrl in case of success

cancelUrlstring required

cancelUrl in case of cancellation

errorUrlstring required

errorUrl in case of error

countryCodestring 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

bankIdstring

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.

transferType0 | 1 | 2

The 'TransferType' can be set to:

  • Instant: Faster SEPA instant transfer.Funds are credited within 15 minutes if supported by the payer's bank.
  • Classic: Standard SEPA credit transfer. Funds are credited in 2–3 business days.

If not provided, the default value is 'Classic'.<br/>0 = Undefined.<br/>1 = Instant.<br/>2 = Classic.<br/>

referencestring

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

accountIdstring required

Payment Account ID to Credit

totalAmountinteger

Amount to Debit Amounts are given as integer numbers in cents

commissionAmountinteger

Your Fee Amounts are given as integer numbers in cents

commentstring

Comment Regarding the Transaction

autoCommissionboolean

If true:

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

Example request

{
  "returnUrl": "https://fr.wikipedia.org/wiki/OK",
  "cancelUrl": "https://fr.wikipedia.org/wiki/Cancel",
  "errorUrl": "https://fr.wikipedia.org/wiki/Error",
  "countryCode": "FR",
  "bankId": "the-bank-id",
  "transferType": 2,
  "reference": "Dze8778",
  "accountId": "1234",
  "totalAmount": 10000,
  "commissionAmount": 100,
  "comment": "Comment the transaction request",
  "autoCommission": false
}

Response

OK

redirectUrlstring
idinteger

Changes

No recorded changes to this operation across all 1 revision of this API.