Update an IBAN

PATCH /v2/ibans/{id}

This operation allows you to update an IBAN name or change its status. Only provided parameters have an effect on the current state of an IBAN.

Path parameters

id string(uuid) Required

ID of the IBAN.

application/json

Body Required

name string

New IBAN name.
status string

New IBAN status.

Values are active or inactive.
allow_collections boolean

New value for whether or not to accept incoming collections on this IBAN.

Responses

200 application/json

OK
Hide response attributes Show response 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.

PATCH /v2/ibans/{id}

curl \
 --request PATCH 'https://api.memo.bank/v2/ibans/fe98f29d-5165-45ff-83f9-d7aa83e970b5' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","status":"active","allow_collections":true}'

Request examples

{
  "name": "string",
  "status": "active",
  "allow_collections": true
}

Response examples (200)

{
  "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
}