Beneficiaries

Upload a beneficiaries sheet for review

Uploads an XLSX sheet of beneficiaries and validates it without saving anything. Every row comes back with an errors field — null when the row is valid, or an object of field: reason pairs when it is not. If at least one row is valid the response also carries a correlationId, which you pass to Save the uploaded beneficiaries to commit the batch.

post/v2/parties/import

Request

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

Query parameters

type'beneficiary' required

Must be beneficiary.

Response

The validated rows, and a correlationId when any row passed.

correlationIdstring
messagestring

Changes

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