Memo Bank API documentation

Changelog

Last update:
Compare

API structure has changed

This release fixes the fact that some mandatory fields of the API responses weren't marked as mandatory in the documentation.

Note that the fields have always been mandatory, it was just not reflected in the documentation. As a result, these are not breaking changes despite being marked as so by the automatically generated changelog.

Modified 6 Breaking
GET /v2/ibans
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results attribute Modified
GET /v2/ibans/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allow_collections, is_deleted attributes Modified
        • Attributes are now required

          Breaking

GET /v2/transactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • attachment_count attribute Modified
        • Attribute is now required

          Breaking

PATCH /v2/ibans/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allow_collections, is_deleted attributes Modified
        • Attributes are now required

          Breaking

POST /v2/ibans
  • Response
  • 201 response Modified
    • application/json content type Modified
      • allow_collections, is_deleted attributes Modified
        • Attributes are now required

          Breaking

API structure has changed

This release fixes the fact that some mandatory address fields of a SEPA Direct Debit mandate debtor were not marked as mandatory in the documentation.

Note that the fields have always been mandatory, it was just not reflected in the documentation. As a result, these are not breaking changes despite being marked as so by the automatically generated changelog.

Modified 2
POST /v2/collections
  • Body
  • application/json content type Modified
    • mandate attribute Modified
      • debtor property Modified
POST /v2/collections/bulks
  • Body
  • application/json content type Modified
    • collections attribute Modified

API structure has changed

Modified 3
GET /v2/attachments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • results attribute Modified
  • Query
  • include_deleted query parameter Added
GET /v2/attachments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • is_deleted attribute Added
POST /v2/attachments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • is_deleted attribute Added

API structure has changed

Modified 2
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified

API structure has changed

Modified 6
GET /v2/ibans
  • Response
  • 200 response Modified
    • results attribute Modified
  • Query
  • include_deleted query parameter Added
GET /v2/ibans/{id}
  • Response
  • 200 response Modified
    • is_deleted attribute Added
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified
PATCH /v2/ibans/{id}
  • Response
  • 200 response Modified
    • is_deleted attribute Added
POST /v2/ibans
  • Response
  • 201 response Modified
    • is_deleted attribute Added

API structure has changed

Modified 12
GET /v2/accounts
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/accounts/{id}
  • Response
  • 200 response Modified
    • type attribute Added
GET /v2/collections/bulks/{id}/collections
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/collections/{id}
  • Response
  • 200 response Modified
    • custom_id, custom_metadata attributes Added
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
  • Query
  • custom_id query parameter Added
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • custom_id, custom_metadata attributes Added
GET /v2/transfers/bulks/{id}/transfers
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transfers/{id}
  • Response
  • 200 response Modified
    • custom_id, custom_metadata attributes Added
POST /v2/collections
  • Body
  • content type Modified
    • custom_id, custom_metadata attributes Added
  • Response
  • 200 response Modified
    • custom_id, custom_metadata attributes Added
POST /v2/collections/bulks
  • Body
  • content type Modified
    • collections attribute Modified
POST /v2/transfers
  • Body
  • content type Modified
    • custom_id, custom_metadata attributes Added
  • Response
  • 200 response Modified
    • custom_id, custom_metadata attributes Added
POST /v2/transfers/bulks
  • Body
  • content type Modified
    • transfers attribute Modified
Removed 1 Breaking
GET /v2/transactions/{id}/proof
Added 1
GET /v2/transfers/{id}/proof

API structure has changed

Modified 2
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified

API structure has changed

Modified 4
GET /v2/ibans
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/ibans/{id}
  • Response
  • 200 response Modified
    • allow_collections attribute Added
PATCH /v2/ibans/{id}
  • Body
  • content type Modified
    • allow_collections attribute Added
  • Response
  • 200 response Modified
    • allow_collections attribute Added
POST /v2/ibans
  • Body
  • content type Modified
    • allow_collections attribute Added
  • Response
  • 201 response Modified
    • allow_collections attribute Added

API structure has changed

Modified 2
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified
    • local_iban attribute Added

API structure has changed

Added 3
DELETE /v2/collections/{id}
DELETE /v2/transfers/{id}
GET /v2/transactions/{id}/proof

API structure has changed

Modified 10
GET /v2/collections/bulks/{id}/collections
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/collections/{id}
  • Response
  • 200 response Modified
    • end_to_end_id attribute Added
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified
GET /v2/transfers/bulks/{id}/transfers
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transfers/{id}
  • Response
  • 200 response Modified
    • end_to_end_id attribute Added
POST /v2/collections
  • Body
  • content type Modified
    • end_to_end_id attribute Added
  • Response
  • 200 response Modified
    • end_to_end_id attribute Added
POST /v2/collections/bulks
  • Body
  • content type Modified
    • collections attribute Modified
POST /v2/transfers
  • Body
  • content type Modified
    • end_to_end_id attribute Added
  • Response
  • 200 response Modified
    • end_to_end_id attribute Added
POST /v2/transfers/bulks
  • Body
  • content type Modified
    • transfers attribute Modified

API structure has changed

Modified 3 Breaking
GET /v2/attachments
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/attachments/{id}
  • Response
  • 200 response Modified
    • transaction_ids attribute Removed
    • transaction_id attribute Added
POST /v2/attachments
  • Response
  • 201 response Modified
    • transaction_ids attribute Removed
    • transaction_id attribute Added

API structure has changed

Modified 2
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified

API structure has changed

Modified 6
GET /v2/collections/bulks/{id}/collections
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/collections/{id}
  • Response
  • 200 response Modified
    • account_id attribute Added
GET /v2/transfers/bulks/{id}/transfers
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transfers/{id}
  • Response
  • 200 response Modified
    • account_id attribute Added
POST /v2/collections
  • Response
  • 200 response Modified
    • account_id attribute Added
POST /v2/transfers
  • Response
  • 200 response Modified
    • account_id attribute Added

API structure has changed

Modified 2
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified

API structure has changed

Modified 2
GET /v2/transactions
  • Response
  • 200 response Modified
    • results attribute Modified
GET /v2/transactions/{id}
  • Response
  • 200 response Modified
    • source attribute Modified
Added 6
GET /v2/collections/bulks/{id}
GET /v2/collections/bulks/{id}/collections
GET /v2/transfers/bulks/{id}
GET /v2/transfers/bulks/{id}/transfers
POST /v2/collections/bulks
POST /v2/transfers/bulks

API documentation has been created