POST
/
v1
/
transfers
Create a new transfer
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "beneficiary_id": "9e64eb6c-90dd-45e0-afaf-bd9fa0253674",
  "source_currency": "sgd",
  "source_amount": 112.42,
  "payment_amount": 10000.5,
  "remitter": {
    "entity_type": "company",
    "full_name": "Test Sender",
    "id_number": "FB123456",
    "id_type": "passport",
    "date_of_birth": "1990-10-28",
    "place_of_birth": "Singapore",
    "nationality": "sg",
    "contact_number": "+6598644718",
    "email": "email@gmail.com",
    "address": {
      "street_address": "1 Keong Saik Road",
      "city": "Singapore",
      "state": "Singapore",
      "postal_code": "089109",
      "country": "sg"
    },
    "company_name": "HitPay"
  }
}'
{
  "id": "9e64f9b8-0039-4bc1-bb98-be1c88212a7e",
  "beneficiary": {
    "id": "9e64eb6c-90dd-45e0-afaf-bd9fa0253674",
    "status": "approved",
    "country": "bd",
    "currency": "bdt",
    "transfer_method": "local",
    "holder_name": "SHAH ALAM HERA",
    "holder_type": "individual",
    "account_number": "1503201781283001",
    "bank_name": "BRAC Bank Ltd.",
    "bank_id": "brc-20",
    "email": null,
    "bank_routing_number": "060261726",
    "created_at": "2025-03-10T07:27:16+08:00",
    "updated_at": "2025-03-10T07:27:18+08:00"
  },
  "payment_currency": "bdt",
  "payment_amount": 10000.5,
  "source_currency": "sgd",
  "source_amount": 112.42,
  "exchange_rate": "88.949505",
  "fee": {
    "amount": 0,
    "currency": "sgd",
    "paid_by": "payer"
  },
  "status": "scheduled",
  "created_at": "2025-03-10T08:07:15+08:00"
}

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Body

application/json
​
beneficiary
object

The beneficiary information. Only required if 'beneficiary_id' is not set. The payload depends on the country and payment method. Please refer Create Beneficiary for addtional fields

​
beneficiary_id
string<uuid>

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

​
source_currency
string

It is beneficiary bank account currency.

Example:

"sgd"

​
source_amount
number

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

Required range: x >= 1
Example:

112.42

​
payment_amount
number

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

Required range: x >= 1
Example:

10000.5

​
remitter_id
string

The remitter id. Only pass either remitter or remitter_id.

Example:

"9b294222-3a53-427f-9393-95dc6d63ee6c"

​
remitter
object

The remitter information. Only pass either remitter or remitter_id.

​
remark
string

Transfer note for internal use only

Maximum length: 120
​
reference
string

The reference for the transfer

Maximum length: 120

Response

201

​
id
string
required
​
beneficiary
object
required
​
payment_currency
string
required
​
payment_amount
number
required
​
source_currency
string
required
​
source_amount
number
required
​
exchange_rate
string
required
​
fee
object
required
​
status
enum<string>
required
Available options:
scheduled,
processing,
paid,
failed,
canceled
​
created_at
string
required