Create a virtual IBAN

POST /v1/ibans

application/json

Body Required

account_id string(uuid) Required

ID of the account.
name string Required

Custom name of the new IBAN, as seen in the Memo Bank interface.
allow_collections boolean

Whether or not to accept incoming collections on this IBAN.

Default value is true.

Responses

201 application/json

Created
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.

POST /v1/ibans

curl \
 -X POST https://api.memo.bank/v1/ibans \
 -H "Content-Type: application/json" \
 -d '{"account_id":"29883c3d-0b11-4c38-91b0-af9018cc5b14","name":"customer no12345","allow_collections":false}'

Request examples

{
  "account_id": "29883c3d-0b11-4c38-91b0-af9018cc5b14",
  "name": "customer no12345",
  "allow_collections": false
}

Response examples (201)

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