Create Many Customer Payments
curl --request POST \
--url https://api.upwell.com/api/rest/bulk-customer-payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"paymentLineItems": {
"data": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"customerId": "<string>",
"exchangeRate": "<string>",
"fees": 123,
"id": "<string>",
"invoiceId": "<string>",
"notes": "<string>",
"paymentId": "<string>",
"remittanceLineItemId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"status": "<string>",
"totalAmount": 123,
"totalAmountWithFees": 123,
"transactionDate": "2023-12-25"
}
]
},
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.upwell.com/api/rest/bulk-customer-payments"
payload = { "inputs": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"paymentLineItems": { "data": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"customerId": "<string>",
"exchangeRate": "<string>",
"fees": 123,
"id": "<string>",
"invoiceId": "<string>",
"notes": "<string>",
"paymentId": "<string>",
"remittanceLineItemId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"status": "<string>",
"totalAmount": 123,
"totalAmountWithFees": 123,
"transactionDate": "2023-12-25"
}
] },
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
checkDate: '2023-12-25',
checkOrAchNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
id: '<string>',
paymentLineItems: {
data: [
{
checkDate: '2023-12-25',
checkOrAchNumber: '<string>',
customerId: '<string>',
exchangeRate: '<string>',
fees: 123,
id: '<string>',
invoiceId: '<string>',
notes: '<string>',
paymentId: '<string>',
remittanceLineItemId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
status: '<string>',
totalAmount: 123,
totalAmountWithFees: 123,
transactionDate: '2023-12-25'
}
]
},
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
totalAmount: 123,
transactionDate: '2023-12-25',
updatedAt: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.upwell.com/api/rest/bulk-customer-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://api.upwell.com/api/rest/bulk-customer-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([
'inputs' => [
[
'checkDate' => '2023-12-25',
'checkOrAchNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'id' => '<string>',
'paymentLineItems' => [
'data' => [
[
'checkDate' => '2023-12-25',
'checkOrAchNumber' => '<string>',
'customerId' => '<string>',
'exchangeRate' => '<string>',
'fees' => 123,
'id' => '<string>',
'invoiceId' => '<string>',
'notes' => '<string>',
'paymentId' => '<string>',
'remittanceLineItemId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'status' => '<string>',
'totalAmount' => 123,
'totalAmountWithFees' => 123,
'transactionDate' => '2023-12-25'
]
]
],
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'totalAmount' => 123,
'transactionDate' => '2023-12-25',
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.upwell.com/api/rest/bulk-customer-payments"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"paymentLineItems\": {\n \"data\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"customerId\": \"<string>\",\n \"exchangeRate\": \"<string>\",\n \"fees\": 123,\n \"id\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"notes\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"remittanceLineItemId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"status\": \"<string>\",\n \"totalAmount\": 123,\n \"totalAmountWithFees\": 123,\n \"transactionDate\": \"2023-12-25\"\n }\n ]\n },\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"transactionDate\": \"2023-12-25\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.upwell.com/api/rest/bulk-customer-payments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"paymentLineItems\": {\n \"data\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"customerId\": \"<string>\",\n \"exchangeRate\": \"<string>\",\n \"fees\": 123,\n \"id\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"notes\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"remittanceLineItemId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"status\": \"<string>\",\n \"totalAmount\": 123,\n \"totalAmountWithFees\": 123,\n \"transactionDate\": \"2023-12-25\"\n }\n ]\n },\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"transactionDate\": \"2023-12-25\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/bulk-customer-payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"paymentLineItems\": {\n \"data\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"customerId\": \"<string>\",\n \"exchangeRate\": \"<string>\",\n \"fees\": 123,\n \"id\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"notes\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"remittanceLineItemId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"status\": \"<string>\",\n \"totalAmount\": 123,\n \"totalAmountWithFees\": 123,\n \"transactionDate\": \"2023-12-25\"\n }\n ]\n },\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"transactionDate\": \"2023-12-25\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"createCustomerPayments": {
"returning": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"paymentLineItems": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"id": "<string>",
"invoiceId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"totalAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Customer Payments
Create Many Customer Payments
Create multiple customer payments at once
POST
/
api
/
rest
/
bulk-customer-payments
Create Many Customer Payments
curl --request POST \
--url https://api.upwell.com/api/rest/bulk-customer-payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"paymentLineItems": {
"data": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"customerId": "<string>",
"exchangeRate": "<string>",
"fees": 123,
"id": "<string>",
"invoiceId": "<string>",
"notes": "<string>",
"paymentId": "<string>",
"remittanceLineItemId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"status": "<string>",
"totalAmount": 123,
"totalAmountWithFees": 123,
"transactionDate": "2023-12-25"
}
]
},
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.upwell.com/api/rest/bulk-customer-payments"
payload = { "inputs": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"paymentLineItems": { "data": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"customerId": "<string>",
"exchangeRate": "<string>",
"fees": 123,
"id": "<string>",
"invoiceId": "<string>",
"notes": "<string>",
"paymentId": "<string>",
"remittanceLineItemId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"status": "<string>",
"totalAmount": 123,
"totalAmountWithFees": 123,
"transactionDate": "2023-12-25"
}
] },
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
checkDate: '2023-12-25',
checkOrAchNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
id: '<string>',
paymentLineItems: {
data: [
{
checkDate: '2023-12-25',
checkOrAchNumber: '<string>',
customerId: '<string>',
exchangeRate: '<string>',
fees: 123,
id: '<string>',
invoiceId: '<string>',
notes: '<string>',
paymentId: '<string>',
remittanceLineItemId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
status: '<string>',
totalAmount: 123,
totalAmountWithFees: 123,
transactionDate: '2023-12-25'
}
]
},
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
totalAmount: 123,
transactionDate: '2023-12-25',
updatedAt: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.upwell.com/api/rest/bulk-customer-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://api.upwell.com/api/rest/bulk-customer-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([
'inputs' => [
[
'checkDate' => '2023-12-25',
'checkOrAchNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'id' => '<string>',
'paymentLineItems' => [
'data' => [
[
'checkDate' => '2023-12-25',
'checkOrAchNumber' => '<string>',
'customerId' => '<string>',
'exchangeRate' => '<string>',
'fees' => 123,
'id' => '<string>',
'invoiceId' => '<string>',
'notes' => '<string>',
'paymentId' => '<string>',
'remittanceLineItemId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'status' => '<string>',
'totalAmount' => 123,
'totalAmountWithFees' => 123,
'transactionDate' => '2023-12-25'
]
]
],
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'totalAmount' => 123,
'transactionDate' => '2023-12-25',
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.upwell.com/api/rest/bulk-customer-payments"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"paymentLineItems\": {\n \"data\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"customerId\": \"<string>\",\n \"exchangeRate\": \"<string>\",\n \"fees\": 123,\n \"id\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"notes\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"remittanceLineItemId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"status\": \"<string>\",\n \"totalAmount\": 123,\n \"totalAmountWithFees\": 123,\n \"transactionDate\": \"2023-12-25\"\n }\n ]\n },\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"transactionDate\": \"2023-12-25\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://api.upwell.com/api/rest/bulk-customer-payments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"paymentLineItems\": {\n \"data\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"customerId\": \"<string>\",\n \"exchangeRate\": \"<string>\",\n \"fees\": 123,\n \"id\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"notes\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"remittanceLineItemId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"status\": \"<string>\",\n \"totalAmount\": 123,\n \"totalAmountWithFees\": 123,\n \"transactionDate\": \"2023-12-25\"\n }\n ]\n },\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"transactionDate\": \"2023-12-25\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/bulk-customer-payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"paymentLineItems\": {\n \"data\": [\n {\n \"checkDate\": \"2023-12-25\",\n \"checkOrAchNumber\": \"<string>\",\n \"customerId\": \"<string>\",\n \"exchangeRate\": \"<string>\",\n \"fees\": 123,\n \"id\": \"<string>\",\n \"invoiceId\": \"<string>\",\n \"notes\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"remittanceLineItemId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"status\": \"<string>\",\n \"totalAmount\": 123,\n \"totalAmountWithFees\": 123,\n \"transactionDate\": \"2023-12-25\"\n }\n ]\n },\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"transactionDate\": \"2023-12-25\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"createCustomerPayments": {
"returning": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"paymentLineItems": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"id": "<string>",
"invoiceId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"totalAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Bulk bodies use
{ "inputs": [ ... ] } (plural) — not the singular input wrapper. See Money & payloads.Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.
Body
application/json
Query parameters can also be provided in the request body as a JSON object
Show child attributes
Show child attributes
Response
Responses for POST /api/rest/bulk-customer-payments
response of any mutation on the table "payments"
Show child attributes
Show child attributes
⌘I