Create a loan payment

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "loan_id": "6d0c298f-3e4e-4538-9a71-1d5359c22f71",
  "external_id": "loan-pmt-001",
  "amount": 150000,
  "date": "2024-02-15",
  "splits": [
    {
      "split_type": "PRINCIPAL",
      "amount": 120000
    },
    {
      "split_type": "INTEREST",
      "amount": 30000
    }
  ],
  "method": "ACH"
}
'

import requests

url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments"

payload = {
    "loan_id": "6d0c298f-3e4e-4538-9a71-1d5359c22f71",
    "external_id": "loan-pmt-001",
    "amount": 150000,
    "date": "2024-02-15",
    "splits": [
        {
            "split_type": "PRINCIPAL",
            "amount": 120000
        },
        {
            "split_type": "INTEREST",
            "amount": 30000
        }
    ],
    "method": "ACH"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    loan_id: '6d0c298f-3e4e-4538-9a71-1d5359c22f71',
    external_id: 'loan-pmt-001',
    amount: 150000,
    date: '2024-02-15',
    splits: [
      {split_type: 'PRINCIPAL', amount: 120000},
      {split_type: 'INTEREST', amount: 30000}
    ],
    method: 'ACH'
  })
};

fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'loan_id' => '6d0c298f-3e4e-4538-9a71-1d5359c22f71',
    'external_id' => 'loan-pmt-001',
    'amount' => 150000,
    'date' => '2024-02-15',
    'splits' => [
        [
                'split_type' => 'PRINCIPAL',
                'amount' => 120000
        ],
        [
                'split_type' => 'INTEREST',
                'amount' => 30000
        ]
    ],
    'method' => 'ACH'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments"

	payload := strings.NewReader("{\n  \"loan_id\": \"6d0c298f-3e4e-4538-9a71-1d5359c22f71\",\n  \"external_id\": \"loan-pmt-001\",\n  \"amount\": 150000,\n  \"date\": \"2024-02-15\",\n  \"splits\": [\n    {\n      \"split_type\": \"PRINCIPAL\",\n      \"amount\": 120000\n    },\n    {\n      \"split_type\": \"INTEREST\",\n      \"amount\": 30000\n    }\n  ],\n  \"method\": \"ACH\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"loan_id\": \"6d0c298f-3e4e-4538-9a71-1d5359c22f71\",\n  \"external_id\": \"loan-pmt-001\",\n  \"amount\": 150000,\n  \"date\": \"2024-02-15\",\n  \"splits\": [\n    {\n      \"split_type\": \"PRINCIPAL\",\n      \"amount\": 120000\n    },\n    {\n      \"split_type\": \"INTEREST\",\n      \"amount\": 30000\n    }\n  ],\n  \"method\": \"ACH\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"loan_id\": \"6d0c298f-3e4e-4538-9a71-1d5359c22f71\",\n  \"external_id\": \"loan-pmt-001\",\n  \"amount\": 150000,\n  \"date\": \"2024-02-15\",\n  \"splits\": [\n    {\n      \"split_type\": \"PRINCIPAL\",\n      \"amount\": 120000\n    },\n    {\n      \"split_type\": \"INTEREST\",\n      \"amount\": 30000\n    }\n  ],\n  \"method\": \"ACH\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "loan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "splits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "external_id": "<string>"
      }
    ],
    "amount": 123,
    "date": "2023-12-25",
    "defer_posting": true,
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "external_id": "<string>",
    "processor": "<string>",
    "payment_clearing_account": {
      "type": "Single_Chart_Account",
      "id": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "Current Assets",
      "account_number": "4000",
      "stable_name": {
        "type": "StableName",
        "stable_name": "CURRENT_ASSETS"
      },
      "account_type": {
        "display_name": "Asset"
      },
      "account_subtype": {
        "display_name": "Current Assets"
      }
    },
    "archived_at": "2023-11-07T05:31:56Z",
    "memo": "<string>",
    "metadata": {},
    "reference_number": "<string>"
  }
}

POST

businesses

{businessId}

loans

payments

Create a loan payment

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "loan_id": "6d0c298f-3e4e-4538-9a71-1d5359c22f71",
  "external_id": "loan-pmt-001",
  "amount": 150000,
  "date": "2024-02-15",
  "splits": [
    {
      "split_type": "PRINCIPAL",
      "amount": 120000
    },
    {
      "split_type": "INTEREST",
      "amount": 30000
    }
  ],
  "method": "ACH"
}
'

import requests

url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments"

payload = {
    "loan_id": "6d0c298f-3e4e-4538-9a71-1d5359c22f71",
    "external_id": "loan-pmt-001",
    "amount": 150000,
    "date": "2024-02-15",
    "splits": [
        {
            "split_type": "PRINCIPAL",
            "amount": 120000
        },
        {
            "split_type": "INTEREST",
            "amount": 30000
        }
    ],
    "method": "ACH"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    loan_id: '6d0c298f-3e4e-4538-9a71-1d5359c22f71',
    external_id: 'loan-pmt-001',
    amount: 150000,
    date: '2024-02-15',
    splits: [
      {split_type: 'PRINCIPAL', amount: 120000},
      {split_type: 'INTEREST', amount: 30000}
    ],
    method: 'ACH'
  })
};

fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'loan_id' => '6d0c298f-3e4e-4538-9a71-1d5359c22f71',
    'external_id' => 'loan-pmt-001',
    'amount' => 150000,
    'date' => '2024-02-15',
    'splits' => [
        [
                'split_type' => 'PRINCIPAL',
                'amount' => 120000
        ],
        [
                'split_type' => 'INTEREST',
                'amount' => 30000
        ]
    ],
    'method' => 'ACH'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments"

	payload := strings.NewReader("{\n  \"loan_id\": \"6d0c298f-3e4e-4538-9a71-1d5359c22f71\",\n  \"external_id\": \"loan-pmt-001\",\n  \"amount\": 150000,\n  \"date\": \"2024-02-15\",\n  \"splits\": [\n    {\n      \"split_type\": \"PRINCIPAL\",\n      \"amount\": 120000\n    },\n    {\n      \"split_type\": \"INTEREST\",\n      \"amount\": 30000\n    }\n  ],\n  \"method\": \"ACH\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"loan_id\": \"6d0c298f-3e4e-4538-9a71-1d5359c22f71\",\n  \"external_id\": \"loan-pmt-001\",\n  \"amount\": 150000,\n  \"date\": \"2024-02-15\",\n  \"splits\": [\n    {\n      \"split_type\": \"PRINCIPAL\",\n      \"amount\": 120000\n    },\n    {\n      \"split_type\": \"INTEREST\",\n      \"amount\": 30000\n    }\n  ],\n  \"method\": \"ACH\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/loans/payments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"loan_id\": \"6d0c298f-3e4e-4538-9a71-1d5359c22f71\",\n  \"external_id\": \"loan-pmt-001\",\n  \"amount\": 150000,\n  \"date\": \"2024-02-15\",\n  \"splits\": [\n    {\n      \"split_type\": \"PRINCIPAL\",\n      \"amount\": 120000\n    },\n    {\n      \"split_type\": \"INTEREST\",\n      \"amount\": 30000\n    }\n  ],\n  \"method\": \"ACH\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "loan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "splits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "external_id": "<string>"
      }
    ],
    "amount": 123,
    "date": "2023-12-25",
    "defer_posting": true,
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "external_id": "<string>",
    "processor": "<string>",
    "payment_clearing_account": {
      "type": "Single_Chart_Account",
      "id": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "Current Assets",
      "account_number": "4000",
      "stable_name": {
        "type": "StableName",
        "stable_name": "CURRENT_ASSETS"
      },
      "account_type": {
        "display_name": "Asset"
      },
      "account_subtype": {
        "display_name": "Current Assets"
      }
    },
    "archived_at": "2023-11-07T05:31:56Z",
    "memo": "<string>",
    "metadata": {},
    "reference_number": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId

string<uuid>

required

The UUID of the business.

Body

application/json

The loan payment to create.

Parameters for recording a loan payment. Provide exactly one of loan_id or loan_external_id to identify the loan.

amount

integer<int64>

required

Total payment amount, in cents. Must equal the sum of the splits.

date

string<date>

required

Date of the payment.

loan_id

string<uuid> | null

ID of the loan being paid. Provide this or loan_external_id.

loan_external_id

string | null

External ID of the loan being paid. Provide this or loan_id.

external_id

string | null

Unique ID of the payment in your system for linking purposes.

splits

object[] | null

Breakdown of the payment into principal, interest, and fee portions. Optional for MCA and flex loans: when omitted, Layer derives a PRINCIPAL/FEE split from the loan's fee_percentage (principal = amount / (1 + fee_percentage / 100), fee = remainder). Required for all other loan types. Provide explicit splits to override the derived ones.

Show child attributes

defer_posting

boolean

default:false

If true, the payment is recorded but not posted to the ledger until it is paid out or its due date is reached.

included_in_opening_balance

boolean

default:false

Set to true when recording a historical payment that the loan's opening balance already reflects. The payment must be dated before the opening balance's effective_at (its date is evaluated as midnight US Eastern time at the start of the day). Layer increases the opening balance by the payment's principal portion and moves the opening balance's effective_at back to the payment date, so the explicit record replaces what the opening balance implied and the loan's balance is unchanged. Without this flag, payments dated before the opening balance's effective_at are rejected with a 400. Sending the flag when the loan has no active opening balance, or when the event is not dated before it, also fails with a 400.

method

enum<string>

default:OTHER

Payment method. Defaults to OTHER.

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

processor

string | null

Payment processor, if any (e.g. stripe).

payment_clearing_account_identifier

Account ID · object

Override the clearing account used for the payment. Defaults based on method.

Account ID
Account Stable Name

Show child attributes

memo

string | null

Internal note about the payment.

metadata

object | null

Arbitrary JSON object you can attach for your own use. Layer stores and returns it unchanged.

reference_number

string | null

Reference number for the payment.

Response

201 - application/json

Loan payment created successfully.

data

object

required

A payment made against a loan, broken down into principal, interest, and fee splits.

Show child attributes

List loan payments Fetch a loan payment

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Integrations

Create a loan payment

Authorizations

Path Parameters

Body

Response