Home

EBICS BOX

the following document describes the HTTP API endpoints of the EBICS HTTP module.

Making debits

POST https://ebics.box/debits

You can chose between raw and transactional mode. raw mode will be fed with encoded pre-generated XML documents whereas transactional-mode will take the transactions in a more readable form but therefore need some more parameters than raw-mode.

raw request

all parameters are required!

{
  "document": "< a base64 encoded representation of a pain008 document >"
}

transactional request

all parameters are required!

{
  "creditor_identifier": "",
  "transactions": [
    {
      "name": "Peter Pan",
      "bic": "COLSDE33XXX",
      "iban": "DE51370501981929807319",
      "amount": "100.00",
      "eref": "TRX-unique-end-to-end-id",
      "remittance_information": "",
      "mandate_id": "number",
      "mandate_date_of_signature": "",
      "local_instrument": "CORE",
      "sequence_type": "FRST",
      "requested_date": ""
    }
  ],
  "order_type": "CDD"
}

Making credits

POST https://ebics.box/credits

Same as with debits you can chose between raw and transactional mode

raw request

all parameters are required!

  {
    "document": "< a base64 encoded representation of a pain001 document >"
  }

transactional request

all parameters are required!

  {
    "transactions": [
      {
        "name": "Peter Pan",
        "bic": "COLSDE33XXX",
        "iban": "DE51370501981929807319",
        "amount": "100.00",
        "eref": "TRX-unique-end-to-end-id",
        "remittance_information": ""
      }
    ]
  }

Search Transactions

GET https://ebics.box/transactions

• from
• to
• eref
• remittance_information

[
  {
    "name": "Peter Ebics",
    "bic": "DEUTDEFF",
    "iban": "DE12500105170648489890",
    "amount": "100.00",
    "eref": "TRX-unique-end-to-end-id",
    "remittance_information": "",
    "statement": {
    }
  }
]

Webhooks

Webhooks are used to inform you about new transactions or transactions that couldn't be delivered to the bank.

The basic webhook format is as follows

{
  "id": "e_4a4a74838ccfd7dadcb",
  "type": "transaction.received",
  "data": {

  }
}

Types

• transaction.received
• credit.fullfilled
• credit.failed
• debit.fullfilled
• debit.failed
• debit.chargebacked

Ideas

• preregister transactions (e.g for prepayments) and get informed when the are processed
• check account balance