API Reference

Create direct debit batch approval task

post
https://api.atlar.com/payments/v2beta/direct-debit-batches//approval-tasks

Initiates an asynchronous approval or rejection of every step the caller's role can act on in the batch.

Use GET …/approval-tasks/{taskId} to poll task progress.

Path Params
string
required
^external:[a-zA-Z0-9._\-+=]{1,64}$|^[a-zA-Z0-9\-]{1,256}$

Atlar resource ID or External ID. Prefix External IDs with external:.

Body Params

Request body for initiating a batch approval or rejection task.

string
enum
required

The action to perform on the approval step.

Allowed:
string
length ≤ 255

Rejection reason propagated to each payment's reject event. Required when action is REJECT.

boolean

If true, bump the execution date to today for payments that are approved by this task and whose date is before today at the time of processing. Payments not approved by this task are left untouched. Only applies when action is APPROVE.

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?