PATCH /v1/ibans/{id}
Jwt

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.

  • account_id string(uuid)

    ID of the account to which the IBAN should point.

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 /v1/ibans/{id} 
curl \
 --request PATCH 'https://api.memo.bank/v1/ibans/c70bd7bc-58e0-4fdb-8c1f-70186e0de587' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"customer no12345","status":"active","allow_collections":true,"account_id":"29883c3d-0b11-4c38-91b0-af9018cc5b14"}'
Request examples 
{
  "name": "customer no12345",
  "status": "active",
  "allow_collections": true,
  "account_id": "29883c3d-0b11-4c38-91b0-af9018cc5b14"
}
Response examples (200) 
{
  "id": "c70bd7bc-58e0-4fdb-8c1f-70186e0de587",
  "account_id": "29883c3d-0b11-4c38-91b0-af9018cc5b14",
  "iban": "FR27590171083068762111832788",
  "name": "customer no12345",
  "status": "active",
  "type": "virtual",
  "allow_collections": true,
  "is_deleted": false
}