Skip to main content
POST
/
transfers
cURL
curl --request POST \
  --url https://dev-api.hyperail.io/api/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-service-source: <x-service-source>' \
  --data '
{
  "reference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "<string>",
  "type": "<string>",
  "source": {
    "accountNumber": "<string>"
  },
  "destination": {
    "accountNumber": "<string>",
    "accountName": "<string>",
    "bankCode": "<string>",
    "branchCode": "<string>"
  },
  "narrations": "<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

application/json
​
reference
string<uuid>
required
​
amount
integer<float>
required
​
currency
string
required
​
type
string
required
​
source
object
required
​
destination
object
required
​
narrations
string

Response

A JSON array of create single disbursement objects.