| Name | Type | Description | Notes |
|---|---|---|---|
| tag | String | Custom data that could be used by caller to search the instance. | [optional] |
| userId | Number | Beneficiary's userId | |
| nickName | String | Name choosen by end user to easily recognize the beneficiary. | [optional] |
| name | String | Beneficiary name, linked to bank account. | |
| address | String | Beneficiary address, linked to bank account. | [optional] |
| iban | String | Beneficiary International Bank Account Number. Mandatory if usableForSct is true. | [optional] |
| bic | String | Beneficiary Bank Identifier Code. Mandatory if usableForSct is true. | [optional] |
| sepaCreditorIdentifier | String | Beneficiary SEPA Creditor Identifier. Mandatory to validate incoming direct debit, useless other wise. Between 8 and 35 caracters. If sddB2bWhitelist or sddCoreBlacklist is provided then sepaCreditorIdentifier is mandatory. | [optional] |
| sddB2bWhitelist | [BeneficiariesSddB2bWhitelist] | Each unique mandate reference, with its frequency type, must be explicitely allowed when doing B2B Direct Debit. Furthermore, a mandate not used during more than 36 months will be automatically rejected even if in the white list. If provided, sepaCreditorIdentifier is mandatory. | [optional] |
| sddCoreBlacklist | [String] | Core Direct Debit are accepted by default. If a Core mandate is to be refused on reception, it has to be added to this list. If wild char * (star) is used instead of a UMR, all Direct Debit from this beneficiary will be refused. If provided, sepaCreditorIdentifier is mandatory. | [optional] |
| usableForSct | Boolean | Indicated if the beneficiary can be used for SEPA Credit Transfer. This field is a conveniant way to filter all beneficiaries for a user that would like to do a Credit Transfer. Indeed, beneficaries are created automatically when receiving a Core Direct Debit and therefor by looking at the list you won't be able to idnetify which beneficary to use on SCT. | [optional] [default to false] |
| fields | [String] | List of the object's properties you want to pick up. | [optional] |