API Reference
Start typing to search…

Preview direct debits

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

Preview and validate the batch of direct debits.

Query Params
string

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

integer
1 to 500
Defaults to 100

Limit the number of items in resulting query response.

Body Params
string
enum
required
deprecated

Deprecated: You can approve or reject on batch and individual level regardless of the treatment type.

Allowed:
payments
array of objects
required
length between 1 and 2000
payments*
amount
required
string
enum
required

Direct debit payment scheme. Choose among:

Allowed:
schemeDetails
object
date
required

Requested payment execution date. It is a local date from the source account's point-of-view. Cannot be set to before the current date, and not more than 60 days into the future.

source
required

A reference identifying the source account to collect money from. Can only be an external account.

destination
object
required

A reference to an (internal) Account.

string
required
length ≤ 140

This reference will be sent to the destination bank and recipient. (This type of reference is sometimes also referred to as remittance information.)

string

ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code).

string
enum

Charge bearer specifies which party should bear the charges of the transaction.

Allowed:
string

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

metadata
object | null

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

string
length between 32 and 64

ID of the payment schedule to associate with this direct debit. Defaults to the organization's default schedule.

string

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

boolean

Skip/ignore input records that contain validation errors.

metadata
object | null

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

Responses

Updated 3 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago