Documentation
API v1OnboardingChangelogAPI Status
Start typing to search…

BNPL MoneyOut

BNPL MoneyOut

Similar to card and other payment types, you can view MoneyOut transactions using existing API calls.

Endpoint: GET /v2/moneyins?transactionId={transactionId}

  • Request: Specify the transactionid in the path parameters to receive information about the transaction.
  • Response: MoneyOut transaction details and information regarding the payment plan are shown in the buyNowPayLaterInfo section.

Example: A BNPL transaction is displayed in the buyNowPayLaterInfo section.

The key value that relates to the transaction details:

  • "type": "installments" - indicates that a 3x or 4x installment plan is active on the account.
{
    "transactions": {
        "value": [
            {
                "receiverAccountId": "57d495c7-b432-449f-9e58-85ebb4477087",
                "creditAmount": 4900,
                "scheduledNumber": null,
                "maskedLabel": "",
                "card": {
                    "id": 0,
                    "is3DS": false,
                    "isRegistered": false
                },
                "refundAmount": 0.0,
                "bankReference": null,
                "ChequeSendingAddress_CorporateName": null,
                "ChequeSendingAddress_Street": null,
                "ChequeSendingAddress_City": null,
                "ChequeSendingAddress_PostCode": null,
                "buyNowPayLaterInfo": {
                    "paymentPlanId": 1,
                    "type": "installments"
                },
                "id": 480080,
                "method": 30,
                "date": 1666369580,
                "commissionAmount": 100,
                "comment": "Reference 125534",
                "status": 0,
                "executionDate": 0,
                "lemonWayCommission": {
                    "idp2p": "200040",
                    "amount": 105
                },
                "reference": ""
            }
        ]
    }
}

Multiple Payment Plans

A BNPL transaction is displayed in the buyNowPayLaterInfo section of each transaction. The key value that relates to the transaction details for installments:

The key value that relates to an installment payment:

  • "type": "installments" - indicates that a 3x or 4x installment plan is active on the account.

Key values that identify a deferred payment:

  • "type": "deferred" - indicates that a 15 or 30 payment plan is active on the account.
  • "deferredPaymentDate": "2022-10-28" - The payment in full date.
{
    "transactions": {
        "value": [
            {
                ...
                "buyNowPayLaterInfo": {
                    "paymentPlanId": 1,
                    "type": "installments"
                },
                "id": 240069,
								...
            },
						{
                ...
                "buyNowPayLaterInfo": {
                    "paymentPlanId": 2,
                    "type": "deferred"
                    "deferredPaymentDate": "2022-10-28"
                },
                "id": 258374,
								...
            }
        ]
    }
}

📘

Note

The paymentPlanId is unique to your business and is setup by a Lemonway Implementation Manger when you active BNPL.

📘

Interested in BNPL?

If you are interested in our BNPL solution, contact your local Implementation Manager or contact our support by adding BNPL Service Request in the subject line.

Updated about 1 month ago