Get Transfer by ID

Get a specific Transfer by ID.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Success.

Body

The Transfer View.

string <uuid>

optional

Transfer unique identifier

transfer_number

string

optional

Short reference code for the transfer

sender_reference

string

optional

recipient_code

string

optional

source_of_fund

string

optional

Source of fund type, please refer to References-Fund Sources

purpose_of_transfer

string

optional

Purpose of transfer type, please refer to References-Transfer Purposes

sender

optional

One of

TransferBusinessSenderModel

TransferPersonalSenderModel

Transfer Business Sender Model

type

enum<string>

ContactType

required

Contact Types: personalor business

Allowed values:

personalbusiness

string <uuid> | null

optional

currency

string

required

Example:

SGD

country

string

required

Example:

business

object

ContactBusiness

optional

Abstract Business Contact information used in ContactBusinessModel and ContactBusinessView.

recipient

optional

One of

TransferPersonalRecipientModel

TransferBusinessRecipientModel

Transfer Personal Recipient Model

string <uuid> | null

optional

currency

string

required

Example:

USD

country

string

required

Example:

type

enum<string>

ContactType

required

Contact Types: personalor business

Allowed values:

personalbusiness

bank

object

ContactBankAccountDetail

optional

Bank Detail information of a Recipient.

ewallet

object

TransferEwalletModel

optional

Transfer e-Wallet Model

cash

object

TransferCashModel

optional

Transfer Cash Model

personal

object

ContactPersonalRecpientModel

optional

Abstract Personal Contact information used in ContactPersonalView and ContactPersonalModel.

quotation

object (QuotationView)

optional

Quotation information return in Response.

string <uuid>

optional

Quotation unique identifier

Example:

6d4545f5-2e53-4793-9f12-e57349d89490

payment_channel

enum<string>

optional

Payment channel

bank

ewallet

cash
We support 3 payment channels depending on destination country. Please refer to the respective payment channel Appendix for details information.

Allowed values:

bankcashewallet

source_country

string

optional

Source Country

Example:

source_currency

string

optional

Source (send) three-letter ISO 4217 currency code

Example:

SGD

source_amount

number <double>

optional

Amount in source currency

Example:

777

min_source_amount

number <double>

optional

Minimum source amount to send for remittance transaction

Example:

100

destination_country

string

optional

Destination country

Example:

CN / US / JP / ID

destination_currency

string

optional

Target (receive) three-letter ISO 4217 currency code

Example:

MOP

destination_amount

number <double>

optional

Amount in destination currency

Example:

712.79

rate

number <float>

optional

Exchange mid-rate

Example:

1.03319

ts_rate

number <float>

optional

Transwap rate with commissions

Example:

1.03319

ts_inverse_rate

number <float>

optional

Transwap inverse rate = 1 / ts_rate

fee

number <float>

optional

Conversion fee imposed by Transwap

Example:

87.11

transaction_fee

number <float>

optional

Transaction fee imposed by Transwap partners (Bank/Non-Bank)

Example:

87.11

valid_until

string <date-time>

optional

Validation of Quotation

Example:

2020-12-02T11:40:56.7395777+00:00

created_timestamp

string <date-time>

optional

Exchange rate creation date time in ISO8601 format (e.g 2018-03-22T16:08:02+00:00)

Example:

2020-12-01T11:40:56.7395714+00:00

last_modified_timestamp

string <date>

optional

Last modified date time in ISO8601 format (e.g. 2018-03-22T16:08:02+00:00)

attachments

object (TransferAttachmentView)

optional

string <uuid>

optional

transfer_id

string <uuid>

optional

document_type

enum<string>

optional

Allowed values:

InvoicePurchaseOrderDeliverySlipContractShippingManifestBillOfLandingOthers

file_name

string

optional

created_timestamp

string

optional

last_modified_timestamp

string

optional

status

enum<string>

optional

Transfer status:

created

awaiting_fund

processing

completed

cancelled

rejected

Allowed values:

createdawaiting_fundprocessingcompletedcancelledrejected

status_message

string

optional

Status message / comments

created_timestamp

string

optional

Transaction creation date time in ISO8601 format (e.g 2018-03 -22T16:08:02+00:00)

last_modified_timestamp

string

optional

Last modified date time in ISO8601 format.
(e.g 2018-03-22T16:08:02+00:00)

Example

{
  "id": "8fe85826-9299-41f0-aeb1-75bd2e16c1f7",
  "transfer_number": "TX-20066-P00288",
  "customer_reference": "INV-20129A",
  "recipient_reference": null,
  "source_of_fund": "COMPANY_BANK_ACCOUNT",
  "purpose_of_transfer": "COM",
  "sender": {
    "id": "57cb22ab-eeef-407c-b078-4f7db234822f",
    "type": "personal",
    "currency": "HKD",
    "country": "HK",
    "personal": {
      "first_name": "Napoleon",
      "middle_name": "",
      "last_name": "Levine",
      "other_name": "",
      "gender": "male",
      "date_of_birth": "1991-04-01T00:00:00+00:00",
      "nationality": "CN",
      "email": "napoleonlevine@outlook.com",
      "mobile_number": "+85223688282",
      "country_of_birth": "SG",
      "occupation": "",
      "industry_category": "",
      "industry_sub_category": "",
      "identification": {
        "id_type": "passport",
        "id_number": "G82829182"
      },
      "address": {
        "line1": "14, Yuen Tsuen Ancient Trail",
        "line2": "New Territories",
        "city": "HK",
        "state_or_province": "HK",
        "country": "HK",
        "postal": ""
      }
    }
  },
  "recipient": {
    "id": "011be6f6-3784-40cd-8d25-e2ffe44fed7f",
    "type": "personal",
    "currency": "SGD",
    "country": "SG",
    "personal": {
      "first_name": "Sally",
      "middle_name": "",
      "last_name": "Ng",
      "other_name": "",
      "gender": "female",
      "date_of_birth": "1983-01-22T00:00:00+00:00",
      "nationality": "SG",
      "email": "sally88@gmail.com",
      "mobile_number": "+6582728877",
      "country_of_birth": "SG",
      "occupation": "",
      "industry_category": "",
      "industry_sub_category": "",
      "identification": {
        "id_type": "passport",
        "id_number": "A5134289"
      },
      "address": {
        "line1": "100 Novena Garden",
        "line2": "Prime Tower #02-02",
        "city": "SG",
        "state_or_province": "",
        "country": "SG",
        "postal": "3328198"
      }
    },
    "bank": {
      "bank_name": "Oversea-Chinese Banking Corporation Limited [OCBC Bank]",
      "bank_country": "SG",
      "bank_account_currency": "SGD",
      "bank_account_name": "Sally Ng",
      "bank_account_number": "594-432371-001",
      "ts_bank_code": "TSSG0034",
      "swift_bic_code": "",
      "bank_code": null,
      "sort_code": null,
      "iban_code": null,
      "bsb_code": null,
      "zengin_code": null,
      "isfc_code": null,
      "cnaps_code": null,
      "aba_routing_number": null
    }
  },
  "quotation": {
    "id": "8ca8afbb-fa9f-4efe-a170-528c721d2755",
    "payment_channel": "Bank",
    "source_currency": "HKD",
    "source_country": "HK",
    "destination_currency": "SGD",
    "destination_country": "SG",
    "rate": 1807.939,
    "fee": 160,
    "valid_until": "2020-06-07T17:11:25.7263195+00:00",
    "created_timestamp": "2020-06-06T17:11:25.7258601+00:00",
    "destination_amount": 35869509.76,
    "source_amount": 20000
  },
  "status": "Processing",
  "status_message": "waiting_to_process",
  "created_timestamp": "2020-06-06T17:24:49.3416807+00:00",
  "last_modified_timestamp": null
}

🟠400Bad Request

🟠401Unauthorized

🟠429429

🔴500Server Error

Request

Request samples

Responses