Pay Workflow Bills

post

https://connect.digits.com/v1/workflow/bills/pay

Pay one or more approved bills, either through Digits-managed payment rails or by recording an external/manual payment.

Requires scope: bills:manage.

Body Params

PayWorkflowBillsRequest pays a batch of approved bills through Digits-managed rails or by recording an external payment.

entity

object

required

WorkflowEntitySelector identifies the client organization and entity a
workflow bill request operates on, by Digits-assigned or caller-assigned ID.
Required on all workflow bill requests so a single client_credentials
credential can address any entity it has access to.

bills

array of objects

required

Bills to pay; each must be in Approved status. Bills that are already paid are skipped as no-ops, so
repeating a request is safe. The request is validated as a whole; if any bill is in any other status,
no payments are initiated. At most 1000 bills per call; larger batches are rejected with InvalidArgument.

bills*

userId

string

User's Digits-assigned ID.

userExternalId

string

User's caller-assigned ID, resolved on the backend.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response