Initiate Monthly Recurring Payments
MoneyInSubscriptionInit
How it works
-
Initiate the first transaction
- If you are using the PSP Payment Page, you need to have initiated a Web Payment using Initiate a Web Payment with registerCard=1
- If you are using the Direct Mode (PCI-DSS authorization required), you need to have registered a card using Initiate a Direct Payment (PCI-DSS compliant only)
-
You then need to Initiate Monthly Recurring Payments specifying the cardId returned from the first transaction, and the subscriptionId (a unique reference you indicate for this subscription). You will also need to indicate the number of Recurring Payments you want us to initiate in the count. The amountTot corresponds to the amount of each recurring payment. Please note that by default, recurrences will be collected on the 15th and the first transaction initiated the month following the day of this request.
-
We will create scheduled transactions in the back office (status 14)
-
On each payment execution date, Lemonway will debit the card and change the pending transaction status to success, and then notify you.
XML
<Request>
<MoneyInSubscriptionInit xmlns="Service_mb">
<wlLogin>string</wlLogin>
<wlPass>string</wlPass>
<language>string</language>
<version>string</version>
<walletIp>string</walletIp>
<walletUa>string</walletUa>
<wallet>string</wallet>
<cardId>string</cardId>
<amountTot>string</amount>
<amountCom>string</amountCom>
<comment>string</comment>
<autoCommission>string</autoCommission>
<subscriptionId>string</subscriptionId>
<count>string</count>
</MoneyInSubscriptionInit>
</Request>
<Response>
<?xml version="1.0" encoding="utf-8"?>
<TRANS>
<HPAY>
<ID>string</ID>
<MLABEL>string</MLABEL>
<DATE> string </DATE>
<SEN> string </SEN>
<REC> string </REC>
<DEB> string </DEB>
<CRED> string </CRED>
<COM> string </COM>
<MSG> string </MSG>
<STATUS> string</STATUS>
<EXTRA>
<IS3DS>string</IS3DS>
<CTRY>string</CTRY>
<AUTH>string</AUTH>
</EXTRA>
</HPAY>
</TRANS>
</Response>
JSON
{
"wlLogin": "string",
"wlPass": "string",
"language": "string",
"version": "string",
"walletIp": "string",
"walletUa": "string",
"wallet": "string",
"cardId": "string",
"amountTot": "string",
"amountCom": "string",
"comment": "string",
"autoCommission": "string",
"subscriptionId": "string",
"count": "string"
}
{
"TRANS": {
"HPAY": {
"ID": "string",
"MLABEL": "string",
"DATE": "string",
"SEN": "string",
"REC": "string",
"DEB": "string",
"CRED": "string",
"COM": "string",
"MSG": "string",
"STATUS": "string",
"EXTRA": {
"IS3DS": "string",
"CTRY": "string",
"AUTH": "string"
}
}
}
}
Request Input Description
Element | Description | Mandatory | Format | Example |
---|---|---|---|---|
wallet | Payment account ID to credit | Yes | [0: 256] char | 33612345678 ou taxi67 |
cardId | Card ID linked to the payment account | Yes | int | 243 |
amountTot | Amount to debit from the card | Yes | 2 decimals | 15 |
amountCom | Your fee | No | 2 decimals | 1 |
comment | Comment regarding the transaction | No | [0:140] char | Order 245 |
autoCommission | If Yes, Lemonway's fee is applied | No | [1] char | 0 (No), 1 (Yes) |
subscriptionId | Subscription ID | Yes | [0: 24] char | 0023T400 |
count | Number of operations to be performed on this subscription | Yes | int | 4 |
Response Output Description
Version | Element | Description | Example |
---|---|---|---|
1 | ID | Request ID | 255 |
1 | MLABEL | Hidden card number | XXXX XXXX XXXX 9854 |
1 | DATE | Request date | 10/9/2011 18:09 |
1 | REC | Beneficiary payment account | Pizza56 |
1 | CRED | Amount credited to the payment account (minus fee) | 15 |
1 | COM | Your fee | 2 |
1 | STATUS | 14: scheduled | 14 |
>= 1.1 | EXTRA | Additional information | |
>= 1.1 | EXTRA.IS3DS | If the transaction was 3D-Secured | 1 |
>= 1.1 | EXTRA.CTRY | The country that issued the card | FRA |
>= 1.1 | EXTRA.AUTH | Authorization number | 43245 |