Skip to main content
POST
Request payments

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string
required

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: 255

Body

application/json
amount
number
required
Required range: x >= 0.01
description
string
required
Required string length: 1 - 2000
groupId
string
Minimum string length: 1
memberIds
string[]
Required array length: 1 - 2000 elements
Minimum string length: 1
excludeMemberIds
string[]
currency
string
amountOverrides
object
dueDate
string
earlyDiscount
number
Required range: x >= 0.01
earlyDeadline
string
lateFee
number
Required range: x >= 0.01
lateDeadline
string
autoRemindersEnabled
boolean
default:true
reminderIntervalHours
integer
Required range: x <= 9007199254740991
isRecurring
boolean
default:false
intervalUnit
enum<string>
Available options:
weekly,
monthly,
quarterly,
yearly
totalCycles
integer
Required range: 2 <= x <= 120
startDate
string
installmentMonths
integer
Required range: 2 <= x <= 12
installmentInterval
enum<string>
Available options:
monthly,
quarterly
sendAt
string
deadlineTimeZone
string

Response

Success

batchId
string
required
shows
object
required
members
object[]
required