Upsert Payment

Creates or updates payment information for an existing customer loan. This endpoint should be used in real-time to report new loan payments or payment updates.

Authorization OAuth 2.0

This request requires OAuth 2.0 authorization.

Header Parameters

• Authorization string required

  Bearer {ACCESS_TOKEN}

• Content-Type string required

  application/json

• Accept string required

  application/json

Path Parameters

• customerId string required

  The LMS generated customer ID.

Request Parameters

• loan_id string required

  The LMS generated loan ID.

• lead_id integer required without

  The Decision Cloud generated lead ID.

  DANGER

  Required without management_system_id

• management_system_id integer required without

  The Decision Cloud generated management system ID.

  DANGER

  Required without lead_id

• payment_id string required

  The LMS generated payment ID.

• payment_amount integer

  The payment amount in cents.

• payment_type string

  Enum: Funding Payment First Payment Payment Additional Payment Makeup Payment Payoff Other

• payment_mode string

  Enum: ACH ACH Collection Cashier Check Personal Check Cash Credit Card Debit Card Money Order Money Gram Loan Transfer Wire Transfer Western Union Other

• payment_status string

  Enum: Pending Paid Partially Paid Late Returned Failed Other

• principal integer

  Total amount in cents of principal paid.

• interest integer

  Total amount in cents of interest paid.

• fees integer

  Total amount in cents of any fees paid.

• bank_routing_number string

  The routing transit number for the bank account processing the payment.

• bank_account_number string

  The account number for the bank account processing the payment.

• return_code string

  The ACH return code if the payment is a reversal.

• returned_at string required with

  The datetime the return came back from the bank. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.

  DANGER

  Required with return_code

• fail_code string

  The payment transaction response fail code.

• failed_at string required with

  The datetime the payment transaction failed. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.

  DANGER

  Required with fail_code

• payment_at string

  The datetime of this payment transaction. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.

POST /api/v1/loan-performance/customers/{customerId}/payments

cURL

curl --request POST \
    "https://api.decisioncloud.me/api/v1/loan-performance/customers/1/payments" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"loan_id\": \"{LOAN_ID}\",
    \"lead_id\": 1,
    \"management_system_id\": 1,
    \"payment_id\": \"{PAYMENT_ID}\",
    \"payment_amount\": 8500,
    \"payment_type\": \"First Payment\",
    \"payment_mode\": \"ACH\",
    \"payment_status\": \"Returned\",
    \"principal\": 6500,
    \"interest\": 500,
    \"fees\": 1500,
    \"bank_routing_number\": \"091000019\",
    \"bank_account_number\": \"434343434\",
    \"return_code\": \"RO1\",
    \"returned_at\": \"2021-09-25T04:02:05Z\",
    \"fail_code\": \"01\",
    \"failed_at\": \"2021-09-25T04:02:05Z\",
    \"payment_at\": \"2021-09-25T04:01:57Z\"
}"

JavaScript

const url = new URL(
    "https://api.decisioncloud.me/api/v1/loan-performance/customers/1/payments"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "loan_id": "{LOAN_ID}",
    "lead_id": 1,
    "management_system_id": 1,
    "payment_id": "{PAYMENT_ID}",
    "payment_amount": 8500,
    "payment_type": "First Payment",
    "payment_mode": "ACH",
    "payment_status": "Returned",
    "principal": 6500,
    "interest": 500,
    "fees": 1500,
    "bank_routing_number": "091000019",
    "bank_account_number": "434343434",
    "return_code": "RO1",
    "returned_at": "2021-09-25T04:02:05Z",
    "fail_code": "01",
    "failed_at": "2021-09-25T04:02:05Z",
    "payment_at": "2021-09-25T04:01:57Z"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

PHP

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.decisioncloud.me/api/v1/loan-performance/customers/1/payments',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'loan_id' => '{LOAN_ID}',
            'lead_id' => 1,
            'management_system_id' => 1,
            'payment_id' => '{PAYMENT_ID}',
            'payment_amount' => 8500,
            'payment_type' => 'First Payment',
            'payment_mode' => 'ACH',
            'payment_status' => 'Returned',
            'principal' => 6500,
            'interest' => 500,
            'fees' => 1500,
            'bank_routing_number' => '091000019',
            'bank_account_number' => '434343434',
            'return_code' => 'RO1',
            'returned_at' => '2021-09-25T04:02:05Z',
            'fail_code' => '01',
            'failed_at' => '2021-09-25T04:02:05Z',
            'payment_at' => '2021-09-25T04:01:57Z',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Python

import requests
import json

url = 'https://api.decisioncloud.me/api/v1/loan-performance/customers/1/payments'
payload = {
    "loan_id": "{LOAN_ID}",
    "lead_id": 1,
    "management_system_id": 1,
    "payment_id": "{PAYMENT_ID}",
    "payment_amount": 8500,
    "payment_type": "First Payment",
    "payment_mode": "ACH",
    "payment_status": "Returned",
    "principal": 6500,
    "interest": 500,
    "fees": 1500,
    "bank_routing_number": "091000019",
    "bank_account_number": "434343434",
    "return_code": "RO1",
    "returned_at": "2021-09-25T04:02:05Z",
    "fail_code": "01",
    "failed_at": "2021-09-25T04:02:05Z",
    "payment_at": "2021-09-25T04:01:57Z"
}
headers = {
  'Authorization': 'Bearer {ACCESS_TOKEN}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

201

null

204

null