Create a new Conversion

Create a new Conversion.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Conversion information to create Conversion.

quotation_id

string <uuid>

optional

customer_reference

string | null

optional

Example

{
    "quotation_id": "87e80e38-c1a3-4cbb-b6ad-9486e39b4270",
    "customer_reference": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Body

The Conversion information returned in Response.

string <uuid>

optional

Conversion unique identifier

conversion_number

string

optional

Reference number for this conversion

status

enum<string>

optional

Conversion status:

awaiting_fund

processing

completed

cancelled

rejected

Allowed values:

awaiting_fundprocessingcompletedcancelledrejected

status_message

string

optional

Conversion status message

customer_reference

string

optional

Customer reference for this conversion

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)

transfer_method

enum<string>

optional

Transfer method

local: Domestic transfer method, usually used within the same country.

rtgs: Real-Time Gross Settlement, used for high-value or urgent international transfers.

swift: Society for Worldwide Interbank Financial Telecommunication, used for global bank-to-bank international transfers.
This field indicates the method for creating a quotation and must be provided when performing a quotation from a Hong Kong/United Kingdom premium account.

Allowed values:

localrtgsswift

Example:

local

charge_type

enum<string>

optional

Charge type

our: The sender pays all the fees related to the transfer.

shared: The sender and the receiver share the transfer fees.
This field indicates how the transfer fees are handled when performing a quotation. This field is required when the transfer_method is either rtgsor swift.

Allowed values:

ourshared

Example:

our

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

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

Example

{
    "id": "58f314b0-c052-4496-838f-944933cc4822",
    "conversion_number": "C-2006700018",
    "status": "Processing",
    "status_message": "",
    "customer_reference": "C07062020-1",
    "quotation": {
        "id": "f3a50e32-90bd-4251-9b82-c63f546eef24",
        "source_currency": "HKD",
        "destination_currency": "SGD",
        "source_amount": 5615.5247,
        "destination_amount": 1000,
        "rate": 0.18,
        "fee": 60,
        "valid_until": "2020-06-08T09:14:50.4272597+00:00",
        "created_timestamp": "2020-06-07T09:14:50.4272361+00:00",
        "last_modified_timestamp": "2020-06-07T09:14:50.4272361+00:00"
    },
    "created_timestamp": "2020-06-07T09:16:14.7257579+00:00",
    "last_modified_timestamp": "2020-06-07T09:16:14.7257579+00:00"
}

🟠400Bad Request

🟠401Unauthorized

🟠429429

🔴500Server Error