Path parameters

• id string(uuid) Required

  ID of the bulk.

Query parameters

• status array[string]

  Filter collections by status.

  Values are pending, scheduled, confirmed, canceled, or failed.

• page integer(int32)

  Index of the requested page.

  Minimum value is 1. Default value is 1.

• size integer(int32)

  Number of elements per page in response.

  Minimum value is 1, maximum value is 100. Default value is 10.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • results array[object] Required

    Elements of the page.

    Hide results attributes Show results attributes object

    • id string(uuid) Required

      ID of the collection.

    • reference string(uuid) Required

      Unique reference, can be used to correlate with the resulting Transaction.

    • amount integer(int64) Required

      The collection amount, in cents.

    • currency string Required

      Currency of the amount, in ISO 4217 format.

    • mandate object Required

      The SEPA Direct Debit collection mandate used.

      Additional properties are allowed.

      Hide mandate attributes Show mandate attributes object

      • reference string Required

        The unique mandate reference.

      • scheme string Required

        The mandate scheme.

        Values are b2b or core.

    • scheduled_date string(date) Required

      The collection scheduled date, in ISO8601 format.

    • local_iban string Required

      IBAN credited or to be credited. It can be the main IBAN of an account or a virtual IBAN.

    • account_id string(uuid)

      ID of the account this collection belongs to, it can be missing while we process it according to the local IBAN.

    • status string Required

      Current status of the collection.

      Values are pending, scheduled, confirmed, canceled, or failed.

    • failure_code string

      Code that represents the failure reason when the collection has failed:

      • invalid_mandate_iban: The mandate's IBAN is invalid.
      • unreachable_mandate_iban: The mandate's IBAN is unreachable for the given scheme.
      • missing_debtor_address: The debtor address is missing and required for non-EEA SEPA countries.
      • core_limit_exceeded: The limit for CORE collections was exceeded.
      • debtor_refusal: The debtor has refused the collection.
      • debtor_bank_account_closed: The debtor's bank account is closed.
      • debtor_bank_error: The debtor's bank sent us an error.
      • debtor_bank_invalid_bank_details: The debtor's bank account does not exist or no longer exists.
      • debtor_bank_refusal: The debtor's bank has refused the collection.
      • intermediary_system_error: The interbank network sent us an error.
      • memo_error: Something went wrong on our side.
      • memo_refusal: We had to reject the collection.
      • execution_failure: Other or undefined pre-settlement execution failures.

      The following codes can only be present on collections initiated as part of a bulk. When initiating a single collection, those codes will be returned as an error response and the collection won’t be created at all:

      • current_account_not_found: The provided local IBAN does not exist.
      • creditor_is_saving_account: The provided local IBAN is a Booster account.
      • no_sepa_creditor_identifier: You need to setup a SEPA creditor identifier with your banker.
      • mandate_info_missing: New mandate information must be complete.
      • collection_to_same_account: The local IBAN and the debtor IBAN can not be the same.

      Values are invalid_mandate_iban, unreachable_mandate_iban, missing_debtor_address, core_limit_exceeded, execution_failure, current_account_not_found, no_sepa_creditor_identifier, creditor_is_saving_account, mandate_info_missing, collection_to_same_account, debtor_refusal, debtor_bank_account_closed, debtor_bank_error, debtor_bank_invalid_bank_details, debtor_bank_refusal, intermediary_system_error, memo_error, or memo_refusal.

    • message string

      Message attached to this collection, visible to all involved parties.

    • end_to_end_id string

      Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction.

    • internal_note string

      Internal note attached to this collection, visible only in your Memo Bank workspace.

    • custom_id string

      Custom identifier attached to the transaction resulting from this collection. It is not transmitted nor visible in your Memo Bank workspace. It can only be retrieved or used to search for transactions via Memo Bank API.

    • custom_metadata string

      Custom metadata attached to the transaction resulting from this collection. It is not transmitted nor visible in your Memo Bank workspace and can only be retrieved via API.

  • has_prev boolean Required

    Flag indicating if there is a previous page.

  • has_next boolean Required

    Flag indicating if there is a next page.