Get Entity BNPL Loans

GET

https://api.mercoa.com/entity/:entityId/bnpl/loans

GET

/entity/:entityId/bnpl/loans

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.entity.bnpl.get_loans(
7     entity_id="ent_123",
8 )

Try it

1 [
2   {
3     "loanId": "684adb5d70a01b00596a3106",
4     "businessExternalId": "ent_9a718f18-cd03-4b4d-98a6-32248969cbac",
5     "dueDate": 1752724800000,
6     "originalPrincipalBalance": 914,
7     "drawDate": 1749736285033,
8     "repaidAmount": 0,
9     "paymentMethodId": "68483ffc9b7d57005896805d",
10     "repaymentMethodId": "684adaf3cf8a670059e7f044",
11     "status": "PENDING",
12     "outstandingBalance": {
13       "principalBalance": 823,
14       "feeBalance": 13,
15       "totalBalance": 927,
16       "lateFeeBalance": 0
17     },
18     "invoiceAmount": 914,
19     "invoiceExternalId": "in_5c0e0b6c-6348-47e4-b39b-97e3d69edabd",
20     "invoiceDueDate": 1749709258847,
21     "downPaymentAmount": 91,
22     "installments": [
23       {
24         "number": 0,
25         "startDate": 1749700800000,
26         "dueDate": 1749700800000,
27         "maturityDate": 1749700800000,
28         "outstandingBalance": 91,
29         "amount": 91,
30         "status": "PENDING",
31         "type": "DOWN_PAYMENT",
32         "totalPaid": {
33           "principalBalance": 0,
34           "dueInterest": 0,
35           "totalLateFees": 0,
36           "feeAmount": 0
37         }
38       },
39       {
40         "number": 1,
41         "startDate": 1750392000000,
42         "dueDate": 1750910400000,
43         "maturityDate": 1751342400000,
44         "outstandingBalance": 209,
45         "amount": 209,
46         "status": "PENDING",
47         "type": "REGULAR",
48         "totalPaid": {
49           "principalBalance": 0,
50           "dueInterest": 0,
51           "totalLateFees": 0,
52           "feeAmount": 0
53         }
54       }
55     ],
56     "cadence": "WEEKLY",
57     "baseFeeRate": 1.339283,
58     "termsAgreementFile": "https://persist-agreement-signature-oatfi-api-stg.s3.us-east-1.amazonaws.com/loan%3A%3A684adb5d70a01b00596a3106-1749736285241.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXHRI6YYRXZIPAOTZ%2F20250612%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250612T135329Z&X-Amz-Expires=900&X-Amz-Signature=eb7c598665ea380ae24f2911488707e72f5b1fd9bf6fe42de27e4ded6996dee7&X-Amz-SignedHeaders=host&x-id=GetObject",
59     "invoiceUrl": "https://persist-invoice-pdf-oatfi-api-stg.s3.us-east-1.amazonaws.com/invoice_pdf_evidence/682354a387e0050058fbff2e/684adb5d70a01b00596a3106_2025-06-12T13%3A51%3A25.067Z.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXHRI6YYRXZIPAOTZ%2F20250612%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250612T135329Z&X-Amz-Expires=900&X-Amz-Signature=337e598acf2feaff5b234a3ecad49d6667850c47dbacb888e6ebd75224e10f74&X-Amz-SignedHeaders=host&x-id=GetObject"
60   },
61   {
62     "loanId": "684adb5d70a01b00596a3106",
63     "businessExternalId": "ent_9a718f18-cd03-4b4d-98a6-32248969cbac",
64     "dueDate": 1752724800000,
65     "originalPrincipalBalance": 914,
66     "drawDate": 1749736285033,
67     "repaidAmount": 0,
68     "paymentMethodId": "68483ffc9b7d57005896805d",
69     "repaymentMethodId": "684adaf3cf8a670059e7f044",
70     "status": "PENDING",
71     "outstandingBalance": {
72       "principalBalance": 823,
73       "feeBalance": 13,
74       "totalBalance": 927,
75       "lateFeeBalance": 0
76     },
77     "invoiceAmount": 914,
78     "invoiceExternalId": "in_5c0e0b6c-6348-47e4-b39b-97e3d69edabd",
79     "invoiceDueDate": 1749709258847,
80     "downPaymentAmount": 91,
81     "installments": [
82       {
83         "number": 0,
84         "startDate": 1749700800000,
85         "dueDate": 1749700800000,
86         "maturityDate": 1749700800000,
87         "outstandingBalance": 91,
88         "amount": 91,
89         "status": "PENDING",
90         "type": "DOWN_PAYMENT",
91         "totalPaid": {
92           "principalBalance": 0,
93           "dueInterest": 0,
94           "totalLateFees": 0,
95           "feeAmount": 0
96         }
97       },
98       {
99         "number": 1,
100         "startDate": 1750392000000,
101         "dueDate": 1750910400000,
102         "maturityDate": 1751342400000,
103         "outstandingBalance": 209,
104         "amount": 209,
105         "status": "PENDING",
106         "type": "REGULAR",
107         "totalPaid": {
108           "principalBalance": 0,
109           "dueInterest": 0,
110           "totalLateFees": 0,
111           "feeAmount": 0
112         }
113       }
114     ],
115     "cadence": "WEEKLY",
116     "baseFeeRate": 1.339283,
117     "termsAgreementFile": "https://persist-agreement-signature-oatfi-api-stg.s3.us-east-1.amazonaws.com/loan%3A%3A684adb5d70a01b00596a3106-1749736285241.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXHRI6YYRXZIPAOTZ%2F20250612%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250612T135329Z&X-Amz-Expires=900&X-Amz-Signature=eb7c598665ea380ae24f2911488707e72f5b1fd9bf6fe42de27e4ded6996dee7&X-Amz-SignedHeaders=host&x-id=GetObject",
118     "invoiceUrl": "https://persist-invoice-pdf-oatfi-api-stg.s3.us-east-1.amazonaws.com/invoice_pdf_evidence/682354a387e0050058fbff2e/684adb5d70a01b00596a3106_2025-06-12T13%3A51%3A25.067Z.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXHRI6YYRXZIPAOTZ%2F20250612%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250612T135329Z&X-Amz-Expires=900&X-Amz-Signature=337e598acf2feaff5b234a3ecad49d6667850c47dbacb888e6ebd75224e10f74&X-Amz-SignedHeaders=host&x-id=GetObject"
119   }
120 ]

Get all BNPL loans associated with an entity

Path parameters

entityIdstringRequired

The ID of the entity to get loans for

Response

This endpoint returns a list of objects.

loanIdstring

The unique identifier for the loan

businessExternalIdstring

The external ID of the business entity

dueDateinteger

The final due date as timestamp in milliseconds

originalPrincipalBalanceinteger

The original principal balance in cents

drawDateinteger

The date the loan was drawn as timestamp in milliseconds

repaidAmountinteger

The total amount repaid in cents

paymentMethodIdstring

The ID of the payment method used

repaymentMethodIdstring

The ID of the repayment method

statusenum

The current status of the loan

Allowed values:

outstandingBalanceobject

The current outstanding balance breakdown

invoiceAmountinteger

The original invoice amount in cents

invoiceExternalIdstring

The external ID of the associated invoice

invoiceDueDateinteger

The original invoice due date as timestamp in milliseconds

downPaymentAmountinteger

The down payment amount in cents

installmentslist of objects

List of all installments for this loan

cadenceenum

The payment cadence for the loan

Allowed values:

baseFeeRatedouble

The base fee rate as a percentage

termsAgreementFilestring or null

URL to the terms agreement file

invoiceUrlstring or null

URL to the invoice PDF

Path parameters

Headers

Response

Errors