Record a manual payment
curl --request POST \
--url https://api.dueflow.co/v1/payments/{paymentId}/mark-paid \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 123,
"note": "<string>"
}
'import requests
url = "https://api.dueflow.co/v1/payments/{paymentId}/mark-paid"
payload = {
"amount": 123,
"note": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount: 123, note: '<string>'})
};
fetch('https://api.dueflow.co/v1/payments/{paymentId}/mark-paid', 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.dueflow.co/v1/payments/{paymentId}/mark-paid",
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([
'amount' => 123,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.dueflow.co/v1/payments/{paymentId}/mark-paid"
payload := strings.NewReader("{\n \"amount\": 123,\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.dueflow.co/v1/payments/{paymentId}/mark-paid")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dueflow.co/v1/payments/{paymentId}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"memberId": "<string>",
"groupId": "<string>",
"targetOrganizationId": "<string>",
"description": "<string>",
"amount": "<string>",
"paidToDate": "<string>",
"currency": "<string>",
"status": "pending",
"dueDate": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"warning": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}Record a manual payment
Requires scope
payments:write· Minimum role editor
Records money collected outside Dueflow. Omit amount to settle the full remaining balance, or supply a positive amount in major currency units for a partial payment. Sends a receipt. Requires an Idempotency-Key header.
POST
/
v1
/
payments
/
{paymentId}
/
mark-paid
Record a manual payment
curl --request POST \
--url https://api.dueflow.co/v1/payments/{paymentId}/mark-paid \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"amount": 123,
"note": "<string>"
}
'import requests
url = "https://api.dueflow.co/v1/payments/{paymentId}/mark-paid"
payload = {
"amount": 123,
"note": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({amount: 123, note: '<string>'})
};
fetch('https://api.dueflow.co/v1/payments/{paymentId}/mark-paid', 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.dueflow.co/v1/payments/{paymentId}/mark-paid",
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([
'amount' => 123,
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.dueflow.co/v1/payments/{paymentId}/mark-paid"
payload := strings.NewReader("{\n \"amount\": 123,\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.dueflow.co/v1/payments/{paymentId}/mark-paid")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dueflow.co/v1/payments/{paymentId}/mark-paid")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"memberId": "<string>",
"groupId": "<string>",
"targetOrganizationId": "<string>",
"description": "<string>",
"amount": "<string>",
"paidToDate": "<string>",
"currency": "<string>",
"status": "pending",
"dueDate": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"warning": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"docsUrl": "<string>",
"param": "<string>",
"requiredScopes": [
"<string>"
]
}
}Authorizations
A Dueflow access token: dfp_ (personal) or dfs_ (service). Permissions are the token's scopes intersected with the role ceiling, re-evaluated per request.
Headers
A unique key per logical operation, e.g. a UUID. Retrying with the same key replays the original response instead of repeating the write; reusing it with different parameters is a 409.
Maximum string length:
255Path Parameters
Body
application/json
Response
Success
Available options:
pending, processing, partially_paid, paid, cancelled, failed, disputed 
