Skip to main content

Multipleatomicgroupsinput

Represents the request payload for creating multiple transactions atomically in groups.

atomicGroups object[]

Atomic Groups list

  • Array [
  • atomicGroupIdstring

    The id of the atomic group, customizable, unique

    transactions object[]

    Transactions list

  • Array [
  • deposit object

    Represents the request payload for creating a transaction of type DEPOSIT.

    amountnumberrequired

    The amount that was added to an account

    bookingDatestring<date-time>

    The date of Journal Entry (as Organization Time)

    Example: 2016-09-06T13:37:50+03:00
    externalIdstring

    The external id of the deposit transaction, customizable, unique

    holdExternalReferenceIdstring

    The external id of an account authorization hold

    notesstring

    Extra notes about this deposit transaction

    paymentDetails object

    The payment information including account identification details

    creditor object

    The details of the party for a transaction

    namestring

    The name of the party

    creditorAccount object

    The account currency and identification

    currencystring

    The currency of the account

    identification object

    The account identification details

    ibanstring

    The account unique identifier

    other object

    Represents other way of identification for the account.

    identificationstring

    The identification of the payer/payee

    schemestring

    The identification scheme

    creditorAgent object

    The agent details for a party

    financialInstitutionIdentification object

    The identification of the financial institution

    bicstring

    Business identifier code

    debtor object

    The details of the party for a transaction

    namestring

    The name of the party

    debtorAccount object

    The account currency and identification

    currencystring

    The currency of the account

    identification object

    The account identification details

    ibanstring

    The account unique identifier

    other object

    Represents other way of identification for the account.

    identificationstring

    The identification of the payer/payee

    schemestring

    The identification scheme

    debtorAgent object

    The agent details for a party

    financialInstitutionIdentification object

    The identification of the financial institution

    bicstring

    Business identifier code

    paymentIdentification object

    The payment identification details

    endToEndIdentificationstring

    Identifier assigned by the initiating party to the transaction

    instructionIdentificationstring

    Identifier of a payment instruction

    transactionIdentificationstring

    Identifier unique for a period assigned by the first initiating party to the transaction

    paymentTypeInformation object

    The information specifying the type of transaction

    serviceLevel object

    The rules under which the transaction should be processed

    codestring

    The code for a pre-agreed service or level of service between the parties

    remittanceInformation object

    The information specifying the payment items that are intended to settle

    structured object

    The information specifying the payment items that are intended to settle

    creditorReferenceInformation object

    Represents the reference to the underlying documents of the payment.

    referencestring

    The reference information of the creditor's underlying documents

    referenceIssuerstring

    The entity that assigns the reference type

    referenceTypestring

    The type of creditor reference

    unstructuredstring

    Information supplied to match the items of the payment in an unstructured form

    paymentOrderIdstring

    The payment order id of the deposit transaction, customizable

    skipMaximumBalanceValidationboolean

    Flag indicating that a maximum balance validation should be skipped

    transactionDetails object

    Contains the details about transaction including fields like transaction channel key and channel ID

    transactionChannelIdstring

    The id of the transaction channel associated with the transaction details.

    transactionChannelKeystring

    The encoded key of the transaction channel associated with the transaction details.

    valueDatestring<date-time>

    The entry date of the deposit (as Organization Time)

    Example: 2016-09-06T13:37:50+03:00
    fee object

    Represents the request payload for creating a transaction of type FEE_APPLIED.

    amountnumber

    The value of the fee applied on the account

    externalIdstring

    The external id of the current transaction, customizable, unique

    notesstring

    Extra notes about the current transaction

    predefinedFeeKeystring

    The encodedKey of the predefined fee that defines the current fee

    withdrawal object

    Represents the input for a withdrawal transaction.

    amountnumberrequired

    The amount to withdraw from account

    bookingDatestring<date-time>

    The date of the withdrawal when the transaction is logged into accounting. If not specified it is considered the value date

    Example: 2016-09-06T13:37:50+03:00
    externalIdstring

    The external id of the withdrawal transaction, customizable, unique

    holdExternalReferenceIdstring

    The external id of an account authorization hold

    notesstring

    Extra notes about this deposit transaction

    paymentDetails object

    The payment information including account identification details

    creditor object

    The details of the party for a transaction

    namestring

    The name of the party

    creditorAccount object

    The account currency and identification

    currencystring

    The currency of the account

    identification object

    The account identification details

    ibanstring

    The account unique identifier

    other object

    Represents other way of identification for the account.

    identificationstring

    The identification of the payer/payee

    schemestring

    The identification scheme

    creditorAgent object

    The agent details for a party

    financialInstitutionIdentification object

    The identification of the financial institution

    bicstring

    Business identifier code

    debtor object

    The details of the party for a transaction

    namestring

    The name of the party

    debtorAccount object

    The account currency and identification

    currencystring

    The currency of the account

    identification object

    The account identification details

    ibanstring

    The account unique identifier

    other object

    Represents other way of identification for the account.

    identificationstring

    The identification of the payer/payee

    schemestring

    The identification scheme

    debtorAgent object

    The agent details for a party

    financialInstitutionIdentification object

    The identification of the financial institution

    bicstring

    Business identifier code

    paymentIdentification object

    The payment identification details

    endToEndIdentificationstring

    Identifier assigned by the initiating party to the transaction

    instructionIdentificationstring

    Identifier of a payment instruction

    transactionIdentificationstring

    Identifier unique for a period assigned by the first initiating party to the transaction

    paymentTypeInformation object

    The information specifying the type of transaction

    serviceLevel object

    The rules under which the transaction should be processed

    codestring

    The code for a pre-agreed service or level of service between the parties

    remittanceInformation object

    The information specifying the payment items that are intended to settle

    structured object

    The information specifying the payment items that are intended to settle

    creditorReferenceInformation object

    Represents the reference to the underlying documents of the payment.

    referencestring

    The reference information of the creditor's underlying documents

    referenceIssuerstring

    The entity that assigns the reference type

    referenceTypestring

    The type of creditor reference

    unstructuredstring

    Information supplied to match the items of the payment in an unstructured form

    paymentOrderIdstring

    The payment order id of the withdrawal transaction, customizable

    transactionDetails object

    Contains the details about transaction including fields like transaction channel key and channel ID

    transactionChannelIdstring

    The id of the transaction channel associated with the transaction details.

    transactionChannelKeystring

    The encoded key of the transaction channel associated with the transaction details.

    valueDatestring<date-time>

    The entry date of the withdrawal. If not specified it is considered the current date (as Organization Time)

    Example: 2016-09-06T13:37:50+03:00
  • ]
  • ]
  • Multipleatomicgroupsinput
    {
    "atomicGroups": [
    {
    "atomicGroupId": "string",
    "transactions": [
    {
    "deposit": {
    "amount": 0,
    "bookingDate": "2016-09-06T13:37:50+03:00",
    "externalId": "string",
    "holdExternalReferenceId": "string",
    "notes": "string",
    "paymentDetails": {
    "creditor": {
    "name": "string"
    },
    "creditorAccount": {
    "currency": "string",
    "identification": {
    "iban": "string",
    "other": {
    "identification": "string",
    "scheme": "string"
    }
    }
    },
    "creditorAgent": {
    "financialInstitutionIdentification": {
    "bic": "string"
    }
    },
    "debtor": {
    "name": "string"
    },
    "debtorAccount": {
    "currency": "string",
    "identification": {
    "iban": "string",
    "other": {
    "identification": "string",
    "scheme": "string"
    }
    }
    },
    "debtorAgent": {
    "financialInstitutionIdentification": {
    "bic": "string"
    }
    },
    "paymentIdentification": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string"
    },
    "paymentTypeInformation": {
    "serviceLevel": {
    "code": "string"
    }
    },
    "remittanceInformation": {
    "structured": {
    "creditorReferenceInformation": {
    "reference": "string",
    "referenceIssuer": "string",
    "referenceType": "string"
    }
    },
    "unstructured": "string"
    }
    },
    "paymentOrderId": "string",
    "skipMaximumBalanceValidation": true,
    "transactionDetails": {
    "transactionChannelId": "string",
    "transactionChannelKey": "string"
    },
    "valueDate": "2016-09-06T13:37:50+03:00"
    },
    "fee": {
    "amount": 0,
    "externalId": "string",
    "notes": "string",
    "predefinedFeeKey": "string"
    },
    "withdrawal": {
    "amount": 0,
    "bookingDate": "2016-09-06T13:37:50+03:00",
    "externalId": "string",
    "holdExternalReferenceId": "string",
    "notes": "string",
    "paymentDetails": {
    "creditor": {
    "name": "string"
    },
    "creditorAccount": {
    "currency": "string",
    "identification": {
    "iban": "string",
    "other": {
    "identification": "string",
    "scheme": "string"
    }
    }
    },
    "creditorAgent": {
    "financialInstitutionIdentification": {
    "bic": "string"
    }
    },
    "debtor": {
    "name": "string"
    },
    "debtorAccount": {
    "currency": "string",
    "identification": {
    "iban": "string",
    "other": {
    "identification": "string",
    "scheme": "string"
    }
    }
    },
    "debtorAgent": {
    "financialInstitutionIdentification": {
    "bic": "string"
    }
    },
    "paymentIdentification": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string"
    },
    "paymentTypeInformation": {
    "serviceLevel": {
    "code": "string"
    }
    },
    "remittanceInformation": {
    "structured": {
    "creditorReferenceInformation": {
    "reference": "string",
    "referenceIssuer": "string",
    "referenceType": "string"
    }
    },
    "unstructured": "string"
    }
    },
    "paymentOrderId": "string",
    "transactionDetails": {
    "transactionChannelId": "string",
    "transactionChannelKey": "string"
    },
    "valueDate": "2016-09-06T13:37:50+03:00"
    }
    }
    ]
    }
    ]
    }