Documentation
API v1OnboardingChangelogAPI Status
Start typing to search…

BNPL MoneyIn

BNPL MoneyIn

Similar to card and other payment types, it is possible to view MoneyIn and 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: MoneyIn transaction details and information with reference to the payment plan are in the buyNowPayLaterInfo section.

Example: A BNPL installments transaction is displayed in the buyNowPayLaterInfo section. Two values identify the transaction details:

  • "paymentPlanId": 1,
  • "type": "installments"
{
    "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

Example: The example displays two types of payment plans: paymentPlanId: 1 (installments)

The key value that relates to an installment payment:

  • "type": "installments"
{
    "transactions": {
        "value": [
            
            {
                "transactionIn": {
                    "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": ""
                }
            },       
            {
                "transactionIn": {
                    "receiverAccountId": "57d495c7-b432-449f-9e58-85ebb4477087",
                    "creditAmount": 4900,
                    "scheduledNumber": null,
                    "maskedLabel": "",
                    "PSP": {
                        "message": "[{\"ShortCode\":\"error_params\",\"Label\":\"app_error\",\"Message\":\"Due to our acceptance rules, we cannot accept this payment. Please choose another payment method.\",\"AdditionalInfo\":\"The purchase cannot be completed\"}]"
                    },
                    "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": 4,
                        "type": "deferred",
                        "deferredPaymentDate": "2022-10-28"
                    },
                    "id": 480076,
                    "method": 30,
                    "date": 1666365609,
                    "commissionAmount": 100,
                    "comment": "Reference 125534",
                    "status": 6,
                    "executionDate": 0,
                    "lemonWayCommission": {
                        "idp2p": "",
                        "amount": 0
                    },
                    "reference": ""
                }
            }
          }
        }

Get a list of all Payment Account Transactions

Endpoint: GET /v2/accounts/{accountId}/transactions

  • Request: Specify the accountid in the Path parameters. Query parameters include:
    • startDate
    • endDate
  • Response: A comprehensive list of all transactions including BNPL. BNPL transactions are displayed with the reference number 30 in the listed items.

🚧

Warning

This call will return a list of all transactions which include all card, SDD, and other payment forms. Only recommended if you want an entire list of transactions.

📘

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