API Reference

Create external account

post
https://api.atlar.com/payments/v2/external-accounts

Create an external account associated with a Counterparty. A maximum of 25 accounts can be created per counterparty.

Body Params
string
required

The ID of the counterparty to which this external account belongs.

string
required
length between 2 and 2

Two-letter ISO 3166-1 alpha2 country code.

identifiers
array of objects
required
length between 1 and 1
identifiers*
string
enum
required

Account Identifier type. Choose among:

  • IBAN — IBAN
  • NUMBER — Account number
  • ADYEN — Adyen identifier
  • AU_BPAY_BILLER_CODE — Australian BPAY Biller Code
  • DK_FIK — FIK creditor number
  • INVESTMENT_NUMBER — Investment number
  • PAYPAL — PayPal wallet identifier
  • PROPRIETARY — Proprietary identifier
  • SE_BANKGIRO — Bankgiro number
  • SE_PLUSGIRO — Plusgiro number
  • SOLDO — Soldo entity identifier
  • WALLET_ADYEN_BALANCE_PLATFORM — Adyen balance platform wallet identifier
  • WALLET_AIRWALLEX — Airwallex wallet identifier
  • WALLET_CURRENCYCLOUD — Currencycloud wallet identifier
  • WALLET_FLASH_PAYMENTS — Flash Payments wallet identifier
  • WALLET_FREEMARKET — Freemarket wallet identifier
  • WALLET_HYPERWALLET — Hyperwallet wallet identifier
  • WALLET_INPAY — Inpay account identifier
  • WALLET_MERCURY — Mercury wallet identifier
  • WALLET_PAYHAWK — Payhawk wallet identifier
  • WALLET_REVOLUT — Revolut wallet identifier
  • WALLET_SKRILL — Skrill wallet identifier
  • WALLET_STRIPE — Stripe wallet identifier
  • WALLET_SWISSQUOTE — Swissquote wallet identifier
For further information please refer to Account Identifiers
string
required
length between 2 and 2

The market of the AccountIdentifier specifies in which market-context the identifier should be treated.

A NUMBER from Sweden does not look and does not validate in the same way as a NUMBER from GB. The market code is, in most cases, the same as where the account itself is domiciled, but not necessarily. An examples of this discrepancy is Jersey which may have domiciled accounts with market JE, but the account identifier would be an IBAN with country code GB.

string
required
length between 1 and 255

The unformatted identifier itself. For type NUMBER the structure of the account number is country-specific.

routing
array of objects
length ≤ 5
routing
string
length ≤ 255

An additional name, an alias, for the 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.

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