List all IBANs

GET /v1/ibans

Query parameters

  • account_id string(uuid)

    ID of the account.

  • include_deleted boolean

    When set to true, results will include IBANs that have been deleted.

    Default value is false.

  • 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 IBAN.

      • account_id string(uuid) Required

        ID of the account this IBAN belongs to.

      • iban string Required

        Actual value of the IBAN.

      • name string Required

        Name of the IBAN.

      • status string Required

        Status of the IBAN. It determines if an IBAN accepts incoming or outgoing transfers.

        Values are active or inactive.

      • type string Required

        Flag indicating if this IBAN is the main IBAN of an account, or a virtual IBAN. Please note that main IBANs cannot be updated or deleted.

        Values are main or virtual.

      • allow_collections boolean Required

        Whether or not this IBAN accepts incoming collections.

      • is_deleted boolean Required

        Whether or not this IBAN has been deleted.

    • has_prev boolean Required

      Flag indicating if there is a previous page.

    • has_next boolean Required

      Flag indicating if there is a next page.
GET /v1/ibans 
curl \
 -X GET https://api.memo.bank/v1/ibans \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "results": [
    {
      "id": "fe98f29d-5165-45ff-83f9-d7aa83e970b5",
      "account_id": "de2284c3-0360-4e4a-b10d-771f75b772d4",
      "iban": "FR27590171083068762111832788",
      "name": "customer no12345",
      "status": "active",
      "type": "main",
      "allow_collections": true,
      "is_deleted": false
    }
  ],
  "has_prev": true,
  "has_next": true
}