Create credit transfer

post https://api.atlar.com/payments/v2/credit-transfers

Create a credit transfer payment.

Body Params

amount

required

scheme

string

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_BPAY (Australian BPAY)
IL_CT (Israel account-to-account)
SG_CT (Singapore account-to-account)
BG_CT (Bulgarian account-to-account)
MX_CT (Mexican account-to-account)
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-saccount)

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.

reference

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.)

categoryPurpose

string

ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code).

chargeBearer

string

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

regulatoryReporting

array of objects

length ≤ 10

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

regulatoryReporting

externalId

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 12 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

Response body

object

string

required

length between 32 and 64

ID of the credit transfer.

organizationId

string

required

Unique resource identifier for an Organization.

creatorUserId

string

length between 32 and 64

ID of the user that created the credit transfer.

amount

object

required

currency

string

required

length between 3 and 3

Three-letter ISO 4217 currency code.

stringValue

string

required

A string representation of the amount value. This will be
a decimal number if the currency has decimals. The number
is not formatted for display purposes (e.g. with locale
specific thousand separator) and always contains the dot
. character as decimal separator.

value

int64

required

The amount value as an integer (int64) represented in
currency minor units (e.g. 15.02 EUR is represented as the
value 1502).

scheme

string

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_BPAY (Australian BPAY)
IL_CT (Israel account-to-account)
SG_CT (Singapore account-to-account)
BG_CT (Bulgarian account-to-account)
MX_CT (Mexican account-to-account)
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-saccount)

SCT SCT_INST CROSS_BORDER GB_CT_BACS GB_CT_CHAPS GB_CT_FPS SE_A2A SE_GIRO DK_A2A DK_CT_SAMEDAY DK_CT_INST DK_CT_FIK71 DK_CT_FIK73 DK_CT_FIK75 CH_CT NO_CT NO_CT_KID US_CT_ACH US_CT_WIRE IS_CT AU_CT AU_CT_BPAY IL_CT SG_CT BG_CT MX_CT KR_CT TH_CT CA_CT_LYNX CA_CT_ACSS PL_CT

schemeDetails

object

instrument

object

The payment instrument used to initiate the payment. For example Citi has a proprietary payment instrument called WorldLink, which can be used to initiate payments.

intraCompany

boolean

Whether the payment is between companies within the same group.

initiatorId

string

urgency

string

The urgency of the payment.

HIGH

date

required

Requested payment execution date.

status

string

required

Status of a payment. Applicable to both credit transfer payments and direct debit payments.

CREATED APPROVED REJECTED PENDING_SUBMISSION SENT PENDING_AT_BANK ACCEPTED EXECUTED FAILED RETURNED UNKNOWN

statusReason

object

Reason for the status of a payment.

code

string

Failure reason code. If present, this is a ISO 20022 error code.

description

string

Human readable description of the reason. Can be presented to an end-user.

source

object

required

Source account from which funds will be withdrawn. This account will be debited.

type

string

required

Account type specifier. ACCOUNT for internal Account resources. EXTERNAL_ACCOUNT for External Account resources.

ACCOUNT EXTERNAL_ACCOUNT INLINE

string

required

length between 32 and 64

ID of the (internal) Account.

organizationId

string

required

Unique resource identifier for an Organization.

market

string

required

length between 2 and 2

Two-letter ISO 3166-1 alpha2 country code.

identifiers

array of objects

required

length ≥ 1

identifiers*

object

type

string

required

Account Identifier type. Choose among:

IBAN International Bank Account Number
NUMBER A NUMBER is a domestic account number. Different markets will have different look & feel of account numbers. For instance a Swedish NUMBER will be a clearing number (4-5 digits) plus account number concatenated, while a UK NUMBER will only be the 8-digit account number, no sort-code.
SE_BANKGIRO (Swedish BankGiro number)
SE_PLUSGIRO (Swedish PlusGiro number)
DK_FIK Danish FIK creditor number
AU_BPAY_BILLER_CODE Australian BPAY biller code
ADYEN Adyen specific account identifier
PAYPAL PayPal specific account identifier
SOLDO Soldo specific account identifier
WALLET_SWISSQUOTE Swissquote specific wallet account identifier
WALLET_AIRWALLEX Airwallex specific wallet account identifier
WALLET_HYPERWALLET Hyperwallet specific wallet account identifier
WALLET_PAYHAWK Payhawk specific wallet account identifier
WALLET_STRIPE Stripe specific wallet account identifier
WALLET_FREEMARKET Freemarket specific wallet account identifier
INVESTMENT_NUMBER Investment account identifier

For further information please refer to Account Identifiers

IBAN NUMBER SE_BANKGIRO SE_PLUSGIRO DK_FIK AU_BPAY_BILLER_CODE ADYEN PAYPAL SOLDO WALLET_SWISSQUOTE WALLET_AIRWALLEX WALLET_HYPERWALLET WALLET_PAYHAWK WALLET_STRIPE WALLET_FREEMARKET INVESTMENT_NUMBER

market

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.

number

string

required

length between 1 and 255

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

invalid

boolean

Will be true if the account identifier is invalid according to Atlar account identifier validation rules.

routing

array of objects

required

length ≤ 5

routing*

object

type

string

required

A routing identifier of type BIC must be provided to support cross-border/SWIFT payments.

BIC AT_BLZ AU_BSB CA_CPA CH_BCC CH_SIC CN_APS DE_BLZ ES_NCC GB_DSC GR_BIC HK_NCC IE_NCC IN_FSC IT_NCC JP_ZGN NZ_NCC PL_KNR PT_NCC RU_CBC SE_SBA SG_IBG TH_CBC TW_NCC US_ABA US_PID ZA_NCC

number

string

required

length between 1 and 255

The form of the routing number depends on type. E.g. for BIC the value should be an 8 or 11 character BIC/SWIFT code. For GB_DSC (UK domestic routing) the value should be a six digit sort code.

invalid

boolean

Will be true if the routing identifier is invalid according to Atlar validation rules.

constraints

object

Constraints on a RoutingIdentifier.

currency

string

required

length between 3 and 3

Three-letter ISO 4217 currency code.

sourceHolder

object

required

Information about the legal holder of an account.

type

string

required

COUNTERPARTY ENTITY

string

required

Resource ID of either a Counterparty or an Entity.

legalName

string

required

The legal name of the account holder. Some banks, and for some payment schemes, the correctness of the legal name will be validated and payments may be rejected if legal names do not match.

address

object

Postal address of the account holder.

nationalIdentifier

object

The national identifier of the account holder.

partyType

string

The party type of the account holder.

INDIVIDUAL COMPANY

destination

required

Destination account to which funds will be sent. This account will be credited.

destinationHolder

object

required

Information about the legal holder of an account.

type

string

required

COUNTERPARTY ENTITY

string

required

Resource ID of either a Counterparty or an Entity.

legalName

string

required

The legal name of the account holder. Some banks, and for some payment schemes, the correctness of the legal name will be validated and payments may be rejected if legal names do not match.

address

object

Postal address of the account holder.

nationalIdentifier

object

The national identifier of the account holder.

partyType

string

The party type of the account holder.

INDIVIDUAL COMPANY

approvalSteps

array of objects

required

approvalSteps*

object

string

required

The ID of this step. Used when approving/rejecting.

approvalChainId

string

required

The ID of the approval chain that triggered this approval step.

requiredRoleIds

array of strings

length ≤ 10

IDs of the Roles that can approve/reject. Not specified if the step was automatically approved based on an auto-approval chain.

requiredRoleIds

status

string

required

The status of the approval step. PENDING if step is not yet interacted with.

PENDING APPROVED REJECTED

approver

object

User information about the user who approved/rejected. Omitted if step is not yet approved/rejected.

updated

date-time

Timestamp when approved/rejected. Omitted if the step is not yet approved/rejected.

autoApproved

boolean

required

allowCreatorApproval

boolean

Allow approval by the user creating this resource if they have the role required for this step. By default, this is not allowed to conform with a four-eyes principle where approval by another person is required.

sequentialApproval

boolean

If true, the approval steps for this approval chain, specified by approvalChainId, need to be approved in the the order specified by sequenceNumber.

sequenceNumber

integer

The sequence number of this step in the approval chain.

attachedTransactions

array of objects

required

attachedTransactions*

object

type

string

required

The resource type of the attached transaction

TRANSACTION

string

required

ID of the attached transaction resource.

reference

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.)

categoryPurpose

string

ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code).

chargeBearer

string

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

SHARED DEBTOR CREDITOR SERVICE_LEVEL

regulatoryReporting

array of objects

length ≤ 10

regulatoryReporting

object

market

string

required

length between 2 and 2

Two-letter ISO 3166-1 alpha2 country code.

indicator

string

required

Determines which side of the payment the regulatory reporting code applies to. When making a payment to Thailand, one should supply a CREDITOR code (equivalent to iso20022 CRED), while making a payment out of Sweden or Norway may require a DEBTOR code (equivalent to iso20022 DEBT).

CREDITOR DEBTOR BOTH

code

string

required

The actual code to report. Codes are market-specific and found on https://docs.atlar.com

connectionInstructionId

string

The ID of the instruction that was sent to the bank in which this credit transfer was included when it was created.

batch

object

Details of the associated payments batch if the credit transfer was created as part of a batch.

string

required

length between 32 and 64

ID of the batch.

treatment

string

required

The way this batch treats the underlying payments.

INDIVIDUAL_PAYMENTS means that each payment is treated individually.

BATCH means that payment approvals (or rejections) are handled at batch level.

INDIVIDUAL_PAYMENTS BATCH

etag

string

required

ETag based on the
resource version. This can be passed along in If-Match HTTP
header when updating a resource to perform a conditional
update.

externalId

string

metadata

object | null

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

Has additional fields

version

integer

required

≥ 1

Resource version. Starts at value 1 when the resource is
created and increases by one for each successive update.

created

date-time

required

Time at which the resource was created.

updated

date-time

required

Time at which the resource was last updated.

Language

Credentials

Basic

base64


xxxxxxxxxx
20
1
curl --request POST \
2
     --url https://api.atlar.com/payments/v2/credit-transfers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "scheme": "SCT",
8
  "schemeDetails": {
9
    "instrument": {
10
      "type": "US_ACH"
11
    }
12
  },
13
  "source": {
14
    "type": "ACCOUNT"
15
  },
16
  "destination": {
17
    "type": "ACCOUNT"
18
  }
19
}
20
'


xxxxxxxxxx
87
}
1
{
2
  "id": "76992987-48fc-4b03-b609-ea6fdc3045b4",
3
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
4
  "amount": {
5
    "currency": "EUR",
6
    "value": 1502,
7
    "stringValue": "15.02"
8
  },
9
  "date": "2022-05-07",
10
  "scheme": "SCT",
11
  "status": "APPROVED",
12
  "reference": "invoice-2022-05-03-001",
13
  "source": {
14
    "id": "ac1963d7-fff9-4783-aa1d-92acb7b21a19",
15
    "type": "ACCOUNT",
16
    "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
17
    "market": "DE",
18
    "currency": "EUR",
19
    "identifiers": [
20
      {
21
        "market": "DE",
22
        "type": "IBAN",
23
        "number": "DE89370400440532013000"
24
      }
25
    ],

201The created credit transfer.

400Bad request.