STstellar
Disbursements

Upload Disbursement Instructions

Adds a file containing a list of receivers to a DRAFT disbursement. This step is required before a disbursement can begin. The file must be a CSV and has a different possible formats according with the disbursement configuration, and they can be found at public/resources/disbursementTemplates. The operation is idempotent, guaranteed by deleting and recreating the disbursement attributes when this endpoint is called.

post/disbursements/{id}/instructions

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID of the Disbursement

Request body multipart/form-data

filestring binary required

Disbursement instructions file to upload. The CSV file columns can vary depending om the way the disbursement was configured, and the fields are a subset of the following: [phone, email, id, amount, verification, paymentID, walletAddress]

Response

Created

messagestring

Example response

{
  "message": "File uploaded succesfully"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.