Sign in

v1

latestOpenAPI 3.0.02026-07-2691259477.2 KB
MoneyIns | Cheque

Register a Cheque

The following rules apply: If you want to pre-enter the cheques in our system, use the POST /moneyins/cheque/init method<br /> The cheque must be made out to Lemonway<br /> On the back of the cheque, please enter a code to facilitate reconciliation. It will be of the following form: XXXXX-YYYYYYYYYY <br /><ul><li>"XXXXX: code identifying you as indicated in your production configuration form </li><li>-: a separation dash:</li><li>YYYYYYYYY : external identifier of your user's payment account </li></ul> The holder of the cheque must be identical to that of the payment account to be credited <br />

post/v2/moneyins/cheque/init

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

transferIdstring

Leave Empty

partnerstring

Leave empty

chequeType15 | 23

Cheque payment (by default) or Pagaré:<br/>15 = Cheque payment.<br/>23 = Pagaré.<br/>

ChequeNumberstring

The seven-digit number at the bottom left-hand corner of the cheque.

BankIdentifierstring

Zone Interbancaire (ZIB). The twelve-digit number used to identify the cheque holder’s bank.

InternalIdentifierstring

Zone Interne (ZIN). The twelve-digit number used to identify the cheque holder’s account.

RLMCinteger

La Clé de Recomposition de la Ligne Magnétique du Chèque. These 2 numbers help identify a potential counterfeit cheque. (only France)

CheckFnciboolean

Fichier National des Chèques Irréguliers de la Banque de France. This FNCI check allows to make a verification on the cheque information. (only France) Please contact our support for this feature.

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 required

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

{
  "chequeType": 15,
  "ChequeNumber": "1067924",
  "BankIdentifier": "092008206908",
  "InternalIdentifier": "065041500251",
  "RLMC": 46,
  "CheckFnci": false,
  "reference": "Dze8778",
  "accountId": "33612345678",
  "totalAmount": 1500,
  "commissionAmount": 100,
  "comment": "Order number 2457765AX2",
  "autoCommission": false
}

Response

OK