API Reference

Create credit transfer batch

post
https://api.atlar.com/payments/v2beta/credit-transfer-batches

Create a batch of credit transfer payments.

See https://docs.atlar.com/docs/batch-payments for more information.

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

Payment scheme. Choose among:

  • SCT (SEPA Credit Transfer)
  • SCT_INST (SEPA Instant Credit Transfer)
  • CROSS_BORDER (Swift)
  • GB_CT_BACS (UK account-to-account BACS)
  • GB_CT_CHAPS (UK account-to-account CHAPS)
  • GB_CT_FPS (UK account-to-account Faster Payments)
  • SE_A2A (Swedish account-to-account)
  • SE_GIRO (Swedish Bankgiro and/or PlusGiro)
  • DK_A2A (Danish account-to-account)
  • DK_CT_SAMEDAY (Danish same-day credit transfer)
  • DK_CT_INST (Danish instant credit transfer)
  • DK_CT_FIK71 (Danish FIK71 credit transfer)
  • DK_CT_FIK73 (Danish FIK73 credit transfer)
  • DK_CT_FIK75 (Danish FIK75 credit transfer)
  • CH_CT (Swiss account-to-account)
  • NO_CT (Norwegian account-to-account)
  • NO_CT_KID (Norwegian KID payment)
  • US_CT_ACH (US ACH)
  • US_CT_WIRE (US Wire)
  • IS_CT (Icelandic account-to-account)
  • AU_CT (Australian account-to-account)
  • AU_CT_BECS (Australian BECS)
  • AU_CT_BPAY (Australian BPAY)
  • HK_CT (Hong Kong account-to-account)
  • IL_CT (Israel account-to-account)
  • SG_CT (Singapore account-to-account)
  • BG_CT (Bulgarian account-to-account)
  • CL_CT (Chilean account-to-account)
  • CZ_CT (Czech account-to-account)
  • MX_CT (Mexican account-to-account)
  • MX_CT_SPID (Mexican account-to-account SPID USD)
  • KR_CT (South Korean account-to-account)
  • TH_CT (Thai account-to-account)
  • CA_CT_LYNX (Canadian Lynx credit transfer)
  • CA_CT_ACSS (Canadian ACSS credit transfer)
  • PL_CT (Polish account-to-account)
  • RO_CT (Romanian account-to-account)
  • TR_CT (Turkish account-to-account)
  • DE_CT (Legacy German account-to-account)
  • FR_CT (Legacy French account-to-account)
  • IN_IMPS (India Immediate Payment Service)
  • IN_NEFT (India National Electronic Funds Transfer)
  • IN_RTGS (India Real-Time Gross Settlement)
  • BR_CT_PIX (Brazilian PIX)
  • BR_CT_TED (Brazilian TED))
  • BOOK_TRANSFER (Book Transfer)
  • CN_CT (Chinese account-to-account)
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
object
required

A reference identifying the source account (as found from /financial-data/v2/accounts).

destination
required

A reference identifying the destination account. Can be either an internal or an external 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:
regulatoryReporting
array of objects
length ≤ 10

Regulatory reporting can be used to provide additional information when needed due to regulatory and statutory requirements.

regulatoryReporting
taxDetails
object

Tax payment details for split payment schemes like Polish MPP (Mechanizm Podzielonej Płatności). When specified and supported, the bank will automatically route the tax amount to the vendor's VAT account.

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 credit transfer. 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 4 days ago

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 4 days ago