Skip to content

Batch create payment requests for all customers with overdue invoices

POST
/v1/payment_requests/batch

Create payment requests for all customers with overdue finalized invoices.

Successful Response

BatchPaymentRequestResponse

Response for batch payment request creation.

object
total_customers
required
Total Customers
integer
created
required
Created
integer
failed
required
Failed
integer
results
required
Results
Array<object>
BatchPaymentRequestResult

Result for a single customer in a batch payment request creation.

object
customer_id
required
Customer Id
string format: uuid
customer_name
required
Customer Name
string
payment_request_id
Any of:
string format: uuid
invoice_count
required
Invoice Count
integer
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_currency
required
Amount Currency
string
status
required
Status
string
error
Any of:
string

Unauthorized