---
title: "Create a new transfer"
method: POST
path: "/v1/transfers"
---

# Create a new transfer

`POST /v1/transfers`

Create a new transfer

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- object
  - `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
    - `country` 'sg' | 'bd' | 'ph' | 'vn' | 'au' — The country code
    - `currency` 'sgd' | 'bdt' | 'php' | 'vnd' | 'aud' — The currency code
    - `transfer_method` string — The transfer method
    - `transfer_type` 'local' — The transfer type
    - `holder_type` 'individual' — The Holder Type
    - `holder_name` string — The Holder Name
  - `beneficiary_id` string, uuid — The Beneficiary id. Only required if 'beneficiary' is not set.
  - `source_currency` string — It is beneficiary bank account currency.
  - `source_amount` number, double — The amount to be transferred. Only required if 'payment_amount' is not set.
  - `payment_amount` number, double — The amount to be transferred. Only required if `source_amount` is not set.
  - `remitter_id` string — The remitter id. Only pass either `remitter` or `remitter_id`.
  - `remitter` object — The remitter information. Only pass either `remitter` or `remitter_id`.
    - `entity_type` 'individual' | 'company'
    - `full_name` string
    - `id_number` string
    - `id_type` 'passport' | 'national_id' | 'driving_license'
    - `date_of_birth` string, date
    - `place_of_birth` string
    - `nationality` string — 2 letter code, lowercase
    - `contact_number` string
    - `email` string
    - `address` object
      - `street_address` string
      - `city` string, required
      - `state` string, required
      - `postal_code` string
      - `country` string — 2 letter code, lowercase
    - `company_name` string — Only required if entity_type is company
  - `remark` string — Transfer note for internal use only
  - `reference` string — The reference for the transfer

## Response `201`

201

- object
  - `id` string, required
  - `beneficiary` object, required
    - `id` string, required
    - `status` string, required
    - `country` string, required
    - `currency` string, required
    - `transfer_method` string, required
    - `holder_name` string, required
    - `holder_type` string, required
    - `account_number` string, required
    - `bank_name` string, required
    - `bank_id` string, required
    - `email` string, nullable, required
    - `bank_routing_number` string, required
    - `created_at` string, required
    - `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
    - `amount` number, required
    - `currency` string, required
    - `paid_by` 'payer' | 'beneficiary', required
  - `status` 'scheduled' | 'processing' | 'paid' | 'failed' | 'canceled', required
  - `created_at` string, required

## Other responses

- `422` — 422

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)