Sign in
Beneficiaries

Creates beneficiaries in batch.

<b>Authorization</b>: End user token is required.

<b>User permissions required</b>: CanCreateBeneficiaries

post/api/v1/beneficiaries/batchcreate

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/beneficiaries/batchcreate
  • Auth: API key in header Authorization

Request body

idstring uuid
merchantIDstring uuid required

Gets or Sets the merchant id.

sourceAccountIDsstring[] nullable
namestring required

The descriptive name for the beneficiary.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC' required

Gets or Sets the currency.

theirReferencestring nullable

Optional reference that will be used by default as TheirReference when creating payouts to this beneficiary if no TheirReference is specified for the payout.

Response

A BeneficiariesCreateResponse.

failedBeneficiariesobject nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.