Beneficiaries

Add a beneficiary

Saves a new beneficiary. Kashier assigns the customerId (a B- prefixed value) and returns the record with the payment method echoed back as transferMethod plus its credentials under credentials.

post/v2/parties

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/parties
  • Auth: API key in header Authorization

Request body

type'beneficiary' required

Must be beneficiary.

namestring required

The beneficiary's name.

phoneNumberstring

The beneficiary's phone number. Optional.

countryCodestring

Required when phoneNumber is set, for example +20.

emailAddressstring

The beneficiary's email address. Optional.

labelsstring[]

Label strings used to organize beneficiaries. Optional.

preferredCommunicationChannel'sms' | 'email' | 'both'
presetNamestring

Saves the customFields keys as a reusable preset under this name. Optional.

Response

The saved beneficiary.

messagestring

Changes

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