Upsert Customer Batch

Creates or updates a large batch of customer resources along with their entire loan and payment history within a single request. The maximum amount of resources permitted is 1000 items per batch request. If an object within a batch is malformed in some way, or violates any validation rules, then that object will simply be skipped. All other objects in the same request may still succeed.

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

Request Parameters

customers array required
- customer_id string required
  The LMS generated customer ID.
customers.loans array required
- 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
- is_lead_loan boolean required
  Determines if this is the loan generated at the time of the lead post.
- application_type string
  Enum: New Returning Refinanced
- loan_type string
  Enum: Payday Installment Line Of Credit
- loan_status string
  Enum: Pending Expired Withdrawn Denied Approved Originated Reversed Past Due Written Off Current Paid In Full
- loan_amount integer required
  The principal loan amount in cents.
- funded_amount integer
  The amount in cents of cash that was actually supplied to the consumer.
- first_payment_date string
  The first payment due date. Must be a valid date in ISO 8601 format YYYY-MM-DD.
- applied_at string required
  The datetime the application was submitted. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.
- esigned_at string
  The datetime the electronic signature was received. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.
- withdrawn_at string
  The datetime the loan was withdrawn. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.
- originated_at string
  The datetime the loan was originated. Must be a valid date in ISO 8601 format YYYY-MM-DDTHH:mm:ssZ.
customers.loans.payments array
- 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.
- 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 required
  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/batches/customers

cURLJavaScriptPHPPython

curl --request POST \
    "https://api.decisioncloud.me/api/v1/loan-performance/batches/customers" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customers\": [
        {
            \"customer_id\": \"{CUSTOMER_ID}\",
            \"loans\": [
                {
                    \"loan_id\": \"{LOAN_ID}\",
                    \"lead_id\": 1,
                    \"management_system_id\": 1,
                    \"is_lead_loan\": true,
                    \"application_type\": \"New\",
                    \"loan_type\": \"Installment\",
                    \"loan_status\": \"Pending\",
                    \"loan_amount\": 75000,
                    \"funded_amount\": 35000,
                    \"first_payment_date\": \"2021-09-25\",
                    \"applied_at\": \"2021-09-25T04:01:57Z\",
                    \"esigned_at\": \"2021-09-25T04:01:57Z\",
                    \"withdrawn_at\": \"2021-09-25T04:01:57Z\",
                    \"originated_at\": \"2021-09-25T04:01:57Z\",
                    \"payments\": [
                        {
                            \"payment_id\": \"{PAYMENT_ID}\",
                            \"payment_amount\": 8500,
                            \"payment_type\": \"First Payment\",
                            \"payment_mode\": \"ACH\",
                            \"payment_status\": \"Returned\",
                            \"principal\": 6500,
                            \"interest\": 500,
                            \"fees\": 1500,
                            \"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\"
                        }
                    ]
                }
            ]
        }
    ]
}"

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

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

let body = {
    "customers": [
        {
            "customer_id": "{CUSTOMER_ID}",
            "loans": [
                {
                    "loan_id": "{LOAN_ID}",
                    "lead_id": 1,
                    "management_system_id": 1,
                    "is_lead_loan": true,
                    "application_type": "New",
                    "loan_type": "Installment",
                    "loan_status": "Pending",
                    "loan_amount": 75000,
                    "funded_amount": 35000,
                    "first_payment_date": "2021-09-25",
                    "applied_at": "2021-09-25T04:01:57Z",
                    "esigned_at": "2021-09-25T04:01:57Z",
                    "withdrawn_at": "2021-09-25T04:01:57Z",
                    "originated_at": "2021-09-25T04:01:57Z",
                    "payments": [
                        {
                            "payment_id": "{PAYMENT_ID}",
                            "payment_amount": 8500,
                            "payment_type": "First Payment",
                            "payment_mode": "ACH",
                            "payment_status": "Returned",
                            "principal": 6500,
                            "interest": 500,
                            "fees": 1500,
                            "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/batches/customers',
    [
        'headers' => [
            'Authorization' => 'Bearer {ACCESS_TOKEN}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'customers' => [
                [
                    'customer_id' => '{CUSTOMER_ID}',
                    'loans' => [
                        [
                            'loan_id' => '{LOAN_ID}',
                            'lead_id' => 1,
                            'management_system_id' => 1,
                            'is_lead_loan' => true,
                            'application_type' => 'New',
                            'loan_type' => 'Installment',
                            'loan_status' => 'Pending',
                            'loan_amount' => 75000,
                            'funded_amount' => 35000,
                            'first_payment_date' => '2021-09-25',
                            'applied_at' => '2021-09-25T04:01:57Z',
                            'esigned_at' => '2021-09-25T04:01:57Z',
                            'withdrawn_at' => '2021-09-25T04:01:57Z',
                            'originated_at' => '2021-09-25T04:01:57Z',
                            'payments' => [
                                [
                                    'payment_id' => '{PAYMENT_ID}',
                                    'payment_amount' => 8500,
                                    'payment_type' => 'First Payment',
                                    'payment_mode' => 'ACH',
                                    'payment_status' => 'Returned',
                                    'principal' => 6500,
                                    'interest' => 500,
                                    'fees' => 1500,
                                    '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));

import requests
import json

url = 'https://api.decisioncloud.me/api/v1/loan-performance/batches/customers'
payload = {
    "customers": [
        {
            "customer_id": "{CUSTOMER_ID}",
            "loans": [
                {
                    "loan_id": "{LOAN_ID}",
                    "lead_id": 1,
                    "management_system_id": 1,
                    "is_lead_loan": true,
                    "application_type": "New",
                    "loan_type": "Installment",
                    "loan_status": "Pending",
                    "loan_amount": 75000,
                    "funded_amount": 35000,
                    "first_payment_date": "2021-09-25",
                    "applied_at": "2021-09-25T04:01:57Z",
                    "esigned_at": "2021-09-25T04:01:57Z",
                    "withdrawn_at": "2021-09-25T04:01:57Z",
                    "originated_at": "2021-09-25T04:01:57Z",
                    "payments": [
                        {
                            "payment_id": "{PAYMENT_ID}",
                            "payment_amount": 8500,
                            "payment_type": "First Payment",
                            "payment_mode": "ACH",
                            "payment_status": "Returned",
                            "principal": 6500,
                            "interest": 500,
                            "fees": 1500,
                            "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()

204

json

null

Upsert Customer Batch

Authorization OAuth 2.0

Header Parameters

Authorization `string` `required`

Content-Type `string` `required`

Accept `string` `required`

Request Parameters

customer_id `string` `required`

loan_id `string` `required`

lead_id `integer` `required without`

management_system_id `integer` `required without`

is_lead_loan `boolean` `required`

application_type `string`

loan_type `string`

loan_status `string`

loan_amount `integer` `required`

funded_amount `integer`

first_payment_date `string`

applied_at `string` `required`

esigned_at `string`

withdrawn_at `string`

originated_at `string`

payment_id `string` `required`

payment_amount `integer`

payment_type `string`

payment_mode `string`

payment_status `string`

principal `integer`

interest `integer`

fees `integer`

return_code `string`

returned_at `string` `required with`

fail_code `string`

failed_at `string` `required with`

payment_at `string` `required`

Upsert Customer Batch ​

Authorization OAuth 2.0 ​

Header Parameters ​

Authorization string required ​

Content-Type string required ​

Accept string required ​

Request Parameters ​

customer_id string required ​

loan_id string required ​

lead_id integer required without ​

management_system_id integer required without ​

is_lead_loan boolean required ​

application_type string ​

loan_type string ​

loan_status string ​

loan_amount integer required ​

funded_amount integer ​

first_payment_date string ​

applied_at string required ​

esigned_at string ​

withdrawn_at string ​

originated_at string ​

payment_id string required ​

payment_amount integer ​

payment_type string ​

payment_mode string ​

payment_status string ​

principal integer ​

interest integer ​

fees integer ​

return_code string ​

returned_at string required with ​

fail_code string ​

failed_at string required with ​

payment_at string required ​

Upsert Customer Batch

Authorization OAuth 2.0

Header Parameters

Authorization `string` `required`

Content-Type `string` `required`

Accept `string` `required`

Request Parameters

customer_id `string` `required`

loan_id `string` `required`

lead_id `integer` `required without`

management_system_id `integer` `required without`

is_lead_loan `boolean` `required`

application_type `string`

loan_type `string`

loan_status `string`

loan_amount `integer` `required`

funded_amount `integer`

first_payment_date `string`

applied_at `string` `required`

esigned_at `string`

withdrawn_at `string`

originated_at `string`

payment_id `string` `required`

payment_amount `integer`

payment_type `string`

payment_mode `string`

payment_status `string`

principal `integer`

interest `integer`

fees `integer`

return_code `string`

returned_at `string` `required with`

fail_code `string`

failed_at `string` `required with`

payment_at `string` `required`