Managed accounts

Get an account IBAN

Fetches the IBAN and bank account details of the managed account identified by the id path parameter.

Use this to poll after adding an IBAN, and to read back the details to display for incoming deposits.

Check state before using the response. UNALLOCATED means no IBAN has been assigned yet, PENDING_ALLOCATION means allocation is still in progress and the details aren't usable, and ALLOCATED means they are ready to share.

bankAccountDetails is a list because a payment model can support more than one IBAN provider. Where several sets are returned, each is a valid route for depositing into the same account.

get/managed_accounts/{id}/iban

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/managed_accounts/{id}/iban
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the managed account.

Response

Success

state'UNALLOCATED' | 'PENDING_ALLOCATION' | 'ALLOCATED' required

The state of the Managed Account's IBAN as follows:

  • UNALLOCATED: The Managed Account has never been assigned an IBAN. Use the managedAccountsIBANUpgrade operation to assign an IBAN to a Managed Account.
  • PENDING_ALLOCATION: The IBAN is being allocated to the Managed Account.
  • ALLOCATED: An IBAN is allocated to the Managed Account.

Example response

{
  "bankAccountDetails": [
    {
      "beneficiaryNameAndSurname": "Alex Smith",
      "beneficiaryBank": "National Westminster Bank PLC",
      "beneficiaryBankAddress": "250 Bishopsgate, London EC2M 4AA",
      "paymentReference": "WVR-123456789",
      "details": {
        "iban": "GB29NWBK60161331926819",
        "bankIdentifierCode": "NWBKGB2L"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.