Sign in

v1

latestOpenAPI 3.0.02026-07-2691259477.2 KB
MoneyIns | Cards

Initiate Monthly Recurring Payments

Use the following steps to ensure a recurring payment can be setup:

  1. Initiate a first transaction
    If you are using the PSP Payment Page, you need to have initiated a Web Payment using POST /moneyins/card/webinit with registerCard=true.
    If you are using the Direct Mode (PCI-DSS authorization required), you need to have registered a card using POST /moneyins/card/register.

  2. You then need to initiate POST /moneyins/card/{cardid}/subscription specifying the Card Id returned from the first transaction, and the Subscription Id (a unique reference you indicate for this subscription).You will also need to precise the number of Recurring Payments you want us to initiate in count. The TotalAmount corresponds to the amount of each recurring payment. By default, the payment will be processed 15th of the month.

  3. We will create scheduled transactions in the Lemonway Dashboard (status 14)

  4. On each payment execution date, Lemonway will debit the card and change the pending transaction status to success, and then notify you.

post/v2/moneyins/card/{cardid}/subscription

Path parameters

cardidinteger required

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

subscriptionIdstring

Subscription ID

Countinteger

Number of operations to be performed on this subscription

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

{
  "subscriptionId": "0023T400",
  "Count": 4,
  "accountId": "33612345678",
  "totalAmount": 1500,
  "commissionAmount": 100,
  "comment": "Order number 2457765AX2",
  "autoCommission": false
}

Response

OK