Sign in
Merchants

Get's a beneficiary by beneficiary ID.

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

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

get/api/v1/merchants/{merchantID}/beneficiaries/{id}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/merchants/{merchantID}/beneficiaries/{id}
  • Auth: API key in header Authorization

Path parameters

merchantIDstring uuid required

The ID of the merchant to get the beneficiary for.

idstring uuid required

The beneficiaryID of the beneficiary to retrieve.

Response

The beneficiary record.

idstring uuid
merchantIDstring uuid

Gets or Sets the merchant id.

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.

approvalCallbackUrlstring nullable
isEnabledboolean
canAuthoriseboolean

True if the beneficiary can be authorised by the user who loaded it.

canUpdateboolean

True if the beneficiary can be updated by the user who loaded it.

hasCurrentUserAuthorisedboolean

True if the beneficiary was loaded for a user and that user has already authorised the latest version of the beneficiary.

authorisersRequiredCountinteger

The number of authorisers required for this beneficiary. Is determined by business settings on the source account and/or merchant.

authorisersCompletedCountinteger

The number of distinct authorisers that have authorised the beneficiary.

authenticationMethodsstring[] nullable

A list of authentication types allowed to authorise the payout.

createdByEmailAddressstring nullable
noncestring nullable
insertedstring date-time
lastUpdatedstring date-time
lastAuthorisedstring date-time nullable
theirReferencestring nullable

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

Changes

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