Halobject

HalBeneficiaries

HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries

Fields (2)

beneficiariesarray<Beneficiary>required
List of trusted beneficiaries
Item schema: Beneficiary
_linksBeneficiariesLinksrequired
Schema: BeneficiariesLinks

Example

{
  "demoBeneficiaries": [
    {
      "creditor": {
        "name": "myMerchant",
        "postalAddress": {
          "country": "FR",
          "addressLine": [
            "18 rue de la DSP2",
            "75008 PARIS"
          ]
        },
        "organisationId": {
          "identification": "852126789",
          "schemeName": "SIREN",
          "issuer": "FR"
        }
      },
      "creditorAccount": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      }
    }
  ],
  "beneficiaries": [
    {
      "creditor": {
        "name": "myMerchant",
        "postalAddress": {
          "country": "FR",
          "addressLine": [
            "18 rue de la DSP2",
            "75008 PARIS"
          ]
        },
        "organisationId": {
          "identification": "852126789",
          "schemeName": "SIREN",
          "issuer": "FR"
        }
      },
      "creditorAccount": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/v1/trusted-beneficiaries"
    },
    "accounts": {
      "href": "/v1/accounts"
    }
  }
}