Register a Cheque

post

https://ws.lemonway.fr/mb/ENVNAME/prod/directkitrest/v2/moneyins/cheque/init

The following rules apply: If you want to pre-enter the cheques in our system, use the POST /moneyins/cheque/init method
The cheque must be made out to Lemonway
On the back of the cheque, please enter a code to facilitate reconciliation. It will be of the following form: XXXXX-YYYYYYYYYY

"XXXXX: code identifying you as indicated in your production configuration form
-: a separation dash:
YYYYYYYYY : external identifier of your user's payment account

The holder of the cheque must be identical to that of the payment account to be credited

Body Params

transferId

string

length between 0 and 8

Leave Empty

partner

string

length between 0 and 256

Leave empty

chequeType

int32

enum

Cheque payment (by default) or Pagaré:
15 = Cheque payment.
23 = Pagaré.

Allowed:

ChequeNumber

string

length between 0 and 7

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

BankIdentifier

string

length between 0 and 12

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

InternalIdentifier

string

length between 0 and 12

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

RLMC

int32

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

CheckFnci

boolean

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.

reference

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

accountId

string

required

length between 0 and 256

Payment Account ID to Credit

totalAmount

int32

Amount to Debit Amounts are given as integer numbers in cents

commissionAmount

int32

Your Fee Amounts are given as integer numbers in cents

comment

string

length between 0 and 140

Comment Regarding the Transaction

autoCommission

boolean

If true:

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

Headers

Authorization

string

required

Authorization bearer (OAuth 2)

PSU-Accept-Language

string

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

PSU-IP-Address

string

required

IP address of the final client (PSU).

PSU-User-Agent

string

User-agent of the final client (PSU).

Responses

401

Unauthorized

500

InternalServerError

200OK