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 standard format that can be found at dev/sample/sample-disbursement.csv. 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 should be in the following format: phone,id,amount,verification

Responses

201

Created

Response Headers

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "File uploaded succesfully"
}

response

{
  "message": "File uploaded succesfully"
}

400

Bad Request

Response Headers

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"
  }
}

response

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

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

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

response

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

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

404

Not Found

Response Headers

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"
  }
}

response

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

Loading...