> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.mercoa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mercoa.com/_mcp/server.

# Get BNPL Loan

GET https://api.mercoa.com/bnpl/loan/{loanId}

Get information about a specific BNPL loan by loan ID

Reference: https://docs.mercoa.com/embedded-ap-ar/api-reference/invoice/bnpl/loan

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `loanId` (string, required) — The ID of the loan to retrieve

## Response

### 200

- `loanId` (string, required) — The unique identifier for the loan
- `businessExternalId` (string, required) — The external ID of the business entity
- `dueDate` (integer, required) — The final due date as timestamp in milliseconds
- `originalPrincipalBalance` (integer, required) — The original principal balance in cents
- `drawDate` (integer, required) — The date the loan was drawn as timestamp in milliseconds
- `repaidAmount` (integer, required) — The total amount repaid in cents
- `paymentMethodId` (string, required) — The ID of the payment method used
- `repaymentMethodId` (string, required) — The ID of the repayment method
- `status` (enum, required) — The current status of the loan
  - Allowed values: `PENDING`, `ACTIVE`, `PAID_OFF`, `DELINQUENT`
- `outstandingBalance` (BnplOutstandingBalance, required) — The current outstanding balance breakdown
- `invoiceAmount` (integer, required) — The original invoice amount in cents
- `invoiceExternalId` (string, required) — The external ID of the associated invoice
- `invoiceDueDate` (integer, required) — The original invoice due date as timestamp in milliseconds
- `downPaymentAmount` (integer, required) — The down payment amount in cents
- `installments` (list of BnplLoanInstallment, required) — List of all installments for this loan
- `cadence` (enum, required) — The payment cadence for the loan
  - Allowed values: `WEEKLY`, `BIWEEKLY`, `MONTHLY`
- `baseFeeRate` (double, required) — The base fee rate as a percentage
- `termsAgreementFile` (string, optional) — URL to the terms agreement file
- `invoiceUrl` (string, optional) — URL to the invoice PDF

## Errors

### 400 Bad Request

- `errorName` ("BadRequest", required)
- `content` (string, required)

### 401 Unauthorized

- `errorName` ("Unauthorized", required)
- `content` (string, required)

### 403 Forbidden

- `errorName` ("Forbidden", required)
- `content` (string, required)

### 404 Not Found

- `errorName` ("NotFound", required)
- `content` (string, required)

### 409 Conflict

- `errorName` ("Conflict", required)
- `content` (string, required)

### 500 Internal Server Error

- `errorName` ("InternalServerError", required)
- `content` (string, required)

### 501 Unimplemented

- `errorName` ("Unimplemented", required)
- `content` (string, required)

## Types

### BnplOutstandingBalance

- `principalBalance` (integer, required) — Outstanding principal balance in cents
- `feeBalance` (integer, required) — Outstanding fee balance in cents
- `totalBalance` (integer, required) — Total outstanding balance in cents
- `lateFeeBalance` (integer, required) — Outstanding late fee balance in cents

### BnplLoanInstallment

- `number` (integer, required) — Installment number (0 for down payment)
- `startDate` (integer, required) — Start date as timestamp in milliseconds
- `dueDate` (integer, required) — Due date as timestamp in milliseconds
- `maturityDate` (integer, required) — Maturity date as timestamp in milliseconds
- `outstandingBalance` (integer, required) — Outstanding balance for this installment in cents
- `amount` (integer, required) — Total amount for this installment in cents
- `status` (enum, required) — Status of this installment
  - Allowed values: `PENDING`, `ACTIVE`, `PAID_OFF`, `DELINQUENT`
- `type` (enum, required) — Type of installment
  - Allowed values: `DOWN_PAYMENT`, `REGULAR`
- `totalPaid` (BnplInstallmentTotalPaid, required) — Total amounts paid for this installment

### BnplInstallmentTotalPaid

- `principalBalance` (integer, required) — Total principal paid in cents
- `dueInterest` (integer, required) — Total interest paid in cents
- `totalLateFees` (integer, required) — Total late fees paid in cents
- `feeAmount` (integer, required) — Total fees paid in cents

## Examples

**Response**

```json
{
  "loanId": "684adb5d70a01b00596a3106",
  "businessExternalId": "ent_9a718f18-cd03-4b4d-98a6-32248969cbac",
  "dueDate": 1752724800000,
  "originalPrincipalBalance": 914,
  "drawDate": 1749736285033,
  "repaidAmount": 0,
  "paymentMethodId": "68483ffc9b7d57005896805d",
  "repaymentMethodId": "684adaf3cf8a670059e7f044",
  "status": "PENDING",
  "outstandingBalance": {
    "principalBalance": 823,
    "feeBalance": 13,
    "totalBalance": 927,
    "lateFeeBalance": 0
  },
  "invoiceAmount": 914,
  "invoiceExternalId": "in_5c0e0b6c-6348-47e4-b39b-97e3d69edabd",
  "invoiceDueDate": 1749709258847,
  "downPaymentAmount": 91,
  "installments": [
    {
      "number": 0,
      "startDate": 1749700800000,
      "dueDate": 1749700800000,
      "maturityDate": 1749700800000,
      "outstandingBalance": 91,
      "amount": 91,
      "status": "PENDING",
      "type": "DOWN_PAYMENT",
      "totalPaid": {
        "principalBalance": 0,
        "dueInterest": 0,
        "totalLateFees": 0,
        "feeAmount": 0
      }
    },
    {
      "number": 1,
      "startDate": 1750392000000,
      "dueDate": 1750910400000,
      "maturityDate": 1751342400000,
      "outstandingBalance": 209,
      "amount": 209,
      "status": "PENDING",
      "type": "REGULAR",
      "totalPaid": {
        "principalBalance": 0,
        "dueInterest": 0,
        "totalLateFees": 0,
        "feeAmount": 0
      }
    }
  ],
  "cadence": "WEEKLY",
  "baseFeeRate": 1.339283,
  "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",
  "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"
}
```

**SDK Code**

```python Get BNPL Loan
import requests

url = "https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```typescript Get BNPL Loan
import { MercoaClient } from "@mercoa/javascript";

const client = new MercoaClient({ token: "YOUR_TOKEN" });
await client.invoice.bnpl.loan("684adb5d70a01b00596a3106");

```

```go Get BNPL Loan
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Get BNPL Loan
require 'uri'
require 'net/http'

url = URI("https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Get BNPL Loan
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Get BNPL Loan
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Get BNPL Loan
using RestSharp;

var client = new RestClient("https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Get BNPL Loan
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.mercoa.com/bnpl/loan/684adb5d70a01b00596a3106")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```