HitPay Product Guide and API docs.

POST

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": {
    "country": "sg",
    "currency": "sgd",
    "transfer_method": "<string>",
    "transfer_type": "local",
    "holder_type": "individual",
    "holder_name": "John Doe"
  },
  "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": "[email protected]",
    "address": {
      "city": "Singapore",
      "state": "SG",
      "street_address": "1 Keong Saik Road",
      "postal_code": "089109",
      "country": "sg"
    },
    "company_name": "HitPay Pte Ltd"
  },
  "remark": "<string>",
  "reference": "<string>"
}
'

{
  "id": "<string>",
  "beneficiary": {
    "id": "<string>",
    "status": "<string>",
    "country": "<string>",
    "currency": "<string>",
    "transfer_method": "<string>",
    "holder_name": "<string>",
    "holder_type": "<string>",
    "account_number": "<string>",
    "bank_name": "<string>",
    "bank_id": "<string>",
    "email": "<string>",
    "bank_routing_number": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "payment_currency": "<string>",
  "payment_amount": 123,
  "source_currency": "<string>",
  "source_amount": 123,
  "exchange_rate": "<string>",
  "fee": {
    "amount": 123,
    "currency": "<string>",
    "paid_by": "payer"
  },
  "status": "scheduled",
  "created_at": "<string>"
}

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

Show child attributes

beneficiary.country

enum<string>

The country code

Available options:

sg,

bd,

ph,

vn,

au

beneficiary.currency

enum<string>

The currency code

Available options:

sgd,

bdt,

php,

vnd,

aud

beneficiary.transfer_method

string

The transfer method

beneficiary.transfer_type

enum<string>

The transfer type

Available options:

local

Example:

"local"

beneficiary.holder_type

enum<string>

The Holder Type

Available options:

individual

Example:

"individual"

beneficiary.holder_name

string

The Holder Name

Maximum string length: 255

Example:

"John Doe"

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<double>

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

Required range: x >= 1

Example:

112.42

payment_amount

number<double>

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.

Show child attributes

remitter.entity_type

enum<string>

Available options:

individual,

company

Example:

"individual"

remitter.full_name

string

Maximum string length: 255

Example:

"John Doe"

remitter.id_number

string

Maximum string length: 255

Example:

"FB123456"

remitter.id_type

enum<string>

Available options:

passport,

national_id,

driving_license

Example:

"passport"

remitter.date_of_birth

string<date>

Maximum string length: 255

Example:

"1990-01-01"

remitter.place_of_birth

string

Example:

"Singapore"

remitter.nationality

string

2 letter code, lowercase

Required string length: 2

Example:

"sg"

remitter.contact_number

string

Maximum string length: 100

Example:

"+6598765432"

remitter.email

string

Maximum string length: 255

Example:

"[email protected]"

remitter.address

object

Show child attributes

remitter.address.city

string

required

Maximum string length: 100

Example:

"Singapore"

remitter.address.state

string

required

Maximum string length: 100

Example:

"SG"

remitter.address.street_address

string

Maximum string length: 255

Example:

"1 Keong Saik Road"

remitter.address.postal_code

string

Maximum string length: 30

Example:

"089109"

remitter.address.country

string

2 letter code, lowercase

Required string length: 2

Example:

"sg"

remitter.company_name

string

Only required if entity_type is company

Maximum string length: 255

Example:

"HitPay Pte Ltd"

remark

string

Transfer note for internal use only

Maximum string length: 120

reference

string

The reference for the transfer

Maximum string length: 120

Response

201

string

required

beneficiary

object

required

Show child attributes

beneficiary.id

string

required

beneficiary.status

string

required

beneficiary.country

string

required

beneficiary.currency

string

required

beneficiary.transfer_method

string

required

beneficiary.holder_name

string

required

beneficiary.holder_type

string

required

beneficiary.account_number

string

required

beneficiary.bank_name

string

required

beneficiary.bank_id

string

required

beneficiary.email

string | null

required

beneficiary.bank_routing_number

string

required

beneficiary.created_at

string

required

beneficiary.updated_at

string

required

payment_currency

string

required

payment_amount

number

required

source_currency

string

required

source_amount

number

required

exchange_rate

string

required

fee

object

required

Show child attributes

fee.amount

number

required

fee.currency

string

required

fee.paid_by

enum<string>

required

Available options:

payer,

beneficiary

status

enum<string>

required

Available options:

scheduled,

processing,

paid,

failed,

canceled

created_at

string

required

Get list of transfersGet list of transfers

⌘I

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": {
    "country": "sg",
    "currency": "sgd",
    "transfer_method": "<string>",
    "transfer_type": "local",
    "holder_type": "individual",
    "holder_name": "John Doe"
  },
  "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": "[email protected]",
    "address": {
      "city": "Singapore",
      "state": "SG",
      "street_address": "1 Keong Saik Road",
      "postal_code": "089109",
      "country": "sg"
    },
    "company_name": "HitPay Pte Ltd"
  },
  "remark": "<string>",
  "reference": "<string>"
}
'

{
  "id": "<string>",
  "beneficiary": {
    "id": "<string>",
    "status": "<string>",
    "country": "<string>",
    "currency": "<string>",
    "transfer_method": "<string>",
    "holder_name": "<string>",
    "holder_type": "<string>",
    "account_number": "<string>",
    "bank_name": "<string>",
    "bank_id": "<string>",
    "email": "<string>",
    "bank_routing_number": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "payment_currency": "<string>",
  "payment_amount": 123,
  "source_currency": "<string>",
  "source_amount": 123,
  "exchange_rate": "<string>",
  "fee": {
    "amount": 123,
    "currency": "<string>",
    "paid_by": "payer"
  },
  "status": "scheduled",
  "created_at": "<string>"
}

API Reference

Headers

Body

Response