Skip to main content
POST
/
transfers
/
bulk
cURL
curl --request POST \
  --url https://dev-api.hyperail.io/api/v1/transfers/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-service-source: <x-service-source>' \
  --form file='@example-file' \
  --form 'category=<string>' \
  --form currency=NGN \
  --form 'narration=<string>'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-service-source
string
default:HyperRails
required

Identifies the calling service

Example:

"HyperRails"

Body

multipart/form-data
​
file
file
required

CSV file containing bulk transfer data. Must be a .csv file.

​
category
string
required

Specify a unique category of your choice for your company to track a transaction for later reconciliation.

​
currency
enum<string>
required

Select the currency for the transfer. This is in our supported currency which is currently only NGN and GHS.

Available options:
NGN,
GHS
​
narration
string
required

This is optional information for you to give details about the reason for the transfer

Response

Bulk transfer created successfully.