Upload Disbursement Instructions

POST 
/disbursements/:id/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.

Request

Path Parameters

id stringrequired

ID of the Disbursement

multipart/form-data

Body

required

file binaryrequired

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]

Responses

201

Created

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "File uploaded succesfully"
}

Example

{
  "message": "File uploaded succesfully"
}

400

Bad Request

application/json

Schema

Schema

error string

extras

object

foo string

message string

Example (from schema)

{
  "error": "Invalid file format *.xyz",
  "extras": {
    "foo": "bar",
    "message": "Not authorized"
  }
}

Example

{
  "error": "Invalid file format *.xyz",
  "extras": {
    "foo": "bar",
    "message": "Not authorized"
  }
}

401

Unauthorized

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Example

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

404

Not Found

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

Example

{
  "error": "Not found",
  "extras": {
    "status": 404,
    "message": "Disbursement not found"
  }
}

Loading...