POST
/
v1
/
transfers
curl --request POST \
  --url https://api.sandbox.hit-pay.com/v1/transfers \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --form beneficiary_id=9ad4789a-c864-48a6-a657-7fdfc57ba1fc \
  --form 'beneficiary={
  "country": "<string>",
  "currency": "sgd",
  "transfer_method": "<string>",
  "holder_name": "<string>",
  "holder_type": "<string>",
  "bank_swift_code": "DBSSSGSG",
  "account_number": "0123456789"
}' \
  --form 'source_currency=<string>' \
  --form source_amount=123 \
  --form payment_amount=123 \
  --form 'remark=<string>' \
  --form 'attached_file=<string>'
{
  "id": "9b2ada28-be3c-47ab-883f-ba72e5d8305d",
  "beneficiary": {
    "id": "9b294222-3a53-427f-9393-95dc6d63ee6c",
    "is_external": true,
    "country": "us",
    "currency": "usd",
    "transfer_method": "local",
    "nickname": null,
    "remark": "Remark Update 1706015123",
    "holder_name": "US Customer123",
    "holder_type": "individual",
    "email": "abc@gmail.com",
    "bank_routing_number": "021000021",
    "account_number": "50001121",
    "address": {
      "city": "New York",
      "state": "US-NY",
      "street": "Test Street",
      "postcode": "10015"
    },
    "is_favourite": false,
    "created_at": "2024-01-23T21:04:15+08:00",
    "updated_at": "2024-01-23T21:05:23+08:00",
    "deleted_at": null
  },
  "payment_currency": "usd",
  "payment_amount": 10,
  "source_currency": "sgd",
  "source_amount": 16.24,
  "exchange_rate": "1.345224",
  "fixed_fee": 2.68,
  "discount_fee": 0,
  "discount_fee_rate": 0,
  "fx_fee": 0.11,
  "fx_fee_rate": 1.5,
  "remark": "Remark 1706083510",
  "status": "to_be_processed",
  "source_type": null,
  "attachment": "https://hitpay-sandbox-public.s3.ap-southeast-1.amazonaws.com/transfer-attachments/9b2ada28-be3c-47ab-883f-ba72e5d8305d/9b2ada28ca004c6cb911b74d64307aa3.jpg",
  "created_at": "2024-01-24T16:05:10+08:00"
}

Headers

X-BUSINESS-API-KEY
string
required

Body

multipart/form-data
beneficiary_id
string

It's required if the beneficiary object is not present

beneficiary
object

It's required if the beneficiary beneficiary_id is not present.

The beneficiary attributes are dependant on the payout corridor and can be check via Get Schema.

source_currency
string
required

The supported currency. Example: sgd

source_amount
number
required

You can only specify one of source_amount or payment_amount

payment_amount
number
required

You can only specify one of source_amount or payment_amount

remark
string | null

Max: 120 chars

attached_file
string | null

Only .jpg, .png, .gif and .pdf extensions are allowed. Maximum file size is 5MB.

Response

201 - application/json
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
fixed_fee
number
required
discount_fee
number
required
discount_fee_rate
number
required
fx_fee
number
required
fx_fee_rate
number
required
remark
string
required
status
string
required
source_type
any
required
attachment
string
required
created_at
string
required