Find Conversions

Find Conversion(s) by parameter(s).

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

source_currency

string | null

optional

Three-letter ISO 4217 currency code

destination_currency

string | null

optional

Three-letter ISO 4217 currency code

start_date

string <date-time> | null

optional

Start date in YYYY-MM-DD format
(e.g. 2020-01-23)

end_date

string <date-time> | null

optional

End date in YYYY-MM-DD format
(e.g. 2020-02-23)

page_index

integer <int32>

optional

The page index of the result

page_size

integer <int32>

optional

the page size of the result.

Responses

🟢200OK

application/json

Success.

Body

items

array[object (ConversionView) {8}]

optional

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.

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)

page_index

integer

optional

page_size

integer

optional

total_items

integer

optional

total_page

integer

optional

Example

{
  "items": [
    {
      "id": "a3e7e460-072b-4453-80f3-149e97bbaa10",
      "conversion_number": "C-2006300014",
      "status": "Rejected",
      "status_message": "Insufficient funds",
      "customer_reference": "Conversion X-22",
      "quotation": {
        "id": "747b329a-94f6-4f6a-a7e2-bc173d5e407b",
        "source_currency": "SGD",
        "destination_currency": "HKD",
        "source_amount": 3000,
        "destination_amount": 16565.3799,
        "rate": 5.5495,
        "fee": 15,
        "valid_until": "2020-06-04T17:04:38.3886082+00:00",
        "created_timestamp": "2020-06-03T17:04:38.3883007+00:00",
        "last_modified_timestamp": "2020-06-03T17:04:38.3883007+00:00"
      },
      "created_timestamp": "2020-06-03T17:06:45.6552971+00:00",
      "last_modified_timestamp": "2020-06-03T17:06:45.6552971+00:00"
    },
    {
      "id": "8d183607-f3d9-455f-948c-af240a552a66",
      "conversion_number": "C-2006400016",
      "status": "Rejected",
      "status_message": "Insufficient funds",
      "customer_reference": "Conversion X-23",
      "quotation": {
        "id": "4ad84fa0-b00f-4aaf-831e-ab1d54ee453d",
        "source_currency": "SGD",
        "destination_currency": "IDR",
        "source_amount": 3000,
        "destination_amount": 30218931.96,
        "rate": 10133.78,
        "fee": 18,
        "valid_until": "2020-06-05T02:00:24.5829682+00:00",
        "created_timestamp": "2020-06-04T02:00:24.5829401+00:00",
        "last_modified_timestamp": "2020-06-04T02:00:24.5829401+00:00"
      },
      "created_timestamp": "2020-06-04T02:04:08.301295+00:00",
      "last_modified_timestamp": "2020-06-04T02:04:08.301295+00:00"
    }
  ],
  "page_index": 0,
  "page_size": 10,
  "total_items": 2,
  "total_page": 1
}

🟠400Bad Request

🟠401Unauthorized

🟠429429

🔴500Server Error

Request

Request samples

Responses