Sign in

v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Create a new transfer

Create a new transfer

post/v1/transfers

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

beneficiary_idstring uuid

The Beneficiary id. Only required if 'beneficiary' is not set.

source_currencystring

It is beneficiary bank account currency.

source_amountnumber double

The amount to be transferred. Only required if 'payment_amount' is not set.

payment_amountnumber double

The amount to be transferred. Only required if source_amount is not set.

remitter_idstring

The remitter id. Only pass either remitter or remitter_id.

remarkstring

Transfer note for internal use only

referencestring

The reference for the transfer

Example request

{
  "beneficiary": {
    "transfer_type": "local",
    "holder_type": "individual",
    "holder_name": "John Doe"
  },
  "source_currency": "sgd",
  "source_amount": 112.42,
  "payment_amount": 10000.5,
  "remitter_id": "9b294222-3a53-427f-9393-95dc6d63ee6c",
  "remitter": {
    "entity_type": "individual",
    "full_name": "John Doe",
    "id_number": "FB123456",
    "id_type": "passport",
    "date_of_birth": "1990-01-01",
    "place_of_birth": "Singapore",
    "nationality": "sg",
    "contact_number": "+6598765432",
    "email": "abc@gmail.com",
    "address": {
      "street_address": "1 Keong Saik Road",
      "city": "Singapore",
      "state": "SG",
      "postal_code": "089109",
      "country": "sg"
    },
    "company_name": "HitPay Pte Ltd"
  }
}

Response

201

idstring required
payment_currencystring required
payment_amountnumber required
source_currencystring required
source_amountnumber required
exchange_ratestring required
status'scheduled' | 'processing' | 'paid' | 'failed' | 'canceled' required
created_atstring required