POST convertTransaction

This operation is to convert a local currency transaction to a DCC currency transaction.

Request Information

URI Parameters

None.

Body Parameters

RateRequest
NameDescriptionTypeAdditional information
deviceId

Device ID
This ID uniquely identify a front-end device/terminal.This can be obtained from activateDCC operation(if applicable).
If this is provided, acquirerId, merchantId and terminalId will be ignored.
If this is absent, acquirerId, merchantId and terminalId must exist.

string

None.

acquirerId

Acquirer ID
See description for deviceId.

string

Range: inclusive between 1 and 99999999999

merchantId

Merchant ID
See description for deviceId.

string

String length: inclusive between 0 and 35

terminalId

Terminal ID
See description for deviceId.

string

String length: inclusive between 0 and 16

localDatetime

Local Transaction Datetime in ISO8601 format with timezone

string

Required

mode

Mode of this request. If this field is absent, the default "single" mode is used.
Possible values:
single - Single rate request.This is default if "mode" is omitted in the request.
all - Multi rates request, all supported currencies are returned

string

None.

baseAmount

Base Amount

BaseAmount

Required

card

Card Information

RequestCard

None.

clientDetails

Client Information

RequestClient

None.

respondAdditionalInfo

Respond Additional Information

RespondAdditionalInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "deviceId": "sample string 1",
  "acquirerId": "sample string 2",
  "merchantId": "sample string 3",
  "terminalId": "sample string 4",
  "localDatetime": "sample string 5",
  "mode": "sample string 6",
  "baseAmount": {
    "currency": "sample string 1",
    "value": "sample string 2"
  },
  "card": {
    "number": "sample string 1",
    "currency": "sample string 2",
    "country": "sample string 3",
    "type": "sample string 4"
  }
}

Response Information

Resource Description

RateResponse
NameDescriptionTypeAdditional information
result

Possible codes: "0000", "6999", "6000", "6001", "6002", "6003", "6004", "6005", "6100"

Result

None.

rrrId

Rate Request Reference ID

string

None.

card

Card Information

ResponseCard

None.

baseAmount

Base Amount

Amount

None.

clientDetails

Client IP Details

ResponseClient

None.

convertedTransaction

Applicable only if the request omitted "mode" property or the mode is set to "single".

ConvertedTransaction

None.

convertedTransactions

List of converted transactions based on all the supported currencies. Applicable only if the request mode is "all".

Collection of ConvertedTransaction

None.

messages

Messages

MessageCollection

None.

Response Formats

application/json, text/json

Sample:
{
  "result": {
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "rrrId": "sample string 1",
  "card": {
    "country": "sample string 1",
    "type": "sample string 2"
  },
  "baseAmount": {
    "value": "sample string 1",
    "fee": "sample string 2",
    "currency": {
      "code": "sample string 1",
      "numericCode": "sample string 2",
      "symbol": "sample string 3",
      "minorUnit": 4,
      "displayUnit": 5
    }
  },
  "clientDetails": {
    "ip": "sample string 1",
    "type": "sample string 2",
    "country": "sample string 3",
    "currency": "sample string 4"
  },
  "convertedTransaction": {
    "amount": {
      "value": "sample string 1",
      "fee": "sample string 2",
      "currency": {
        "code": "sample string 1",
        "numericCode": "sample string 2",
        "symbol": "sample string 3",
        "minorUnit": 4,
        "displayUnit": 5
      }
    },
    "rate": {
      "type": "sample string 1",
      "currency": {
        "code": "sample string 1",
        "numericCode": "sample string 2",
        "symbol": "sample string 3",
        "minorUnit": 4,
        "displayUnit": 5
      },
      "value": "sample string 2",
      "direct": "sample string 3",
      "inverted": "sample string 4",
      "markup": "sample string 5",
      "diffOverECB": "sample string 6",
      "markupOverECB": "sample string 7",
      "fcmid": "sample string 8",
      "fctid": "sample string 9"
    }
  },
  "convertedTransactions": [
    {
      "amount": {
        "value": "sample string 1",
        "fee": "sample string 2",
        "currency": {
          "code": "sample string 1",
          "numericCode": "sample string 2",
          "symbol": "sample string 3",
          "minorUnit": 4,
          "displayUnit": 5
        }
      },
      "rate": {
        "type": "sample string 1",
        "currency": {
          "code": "sample string 1",
          "numericCode": "sample string 2",
          "symbol": "sample string 3",
          "minorUnit": 4,
          "displayUnit": 5
        },
        "value": "sample string 2",
        "direct": "sample string 3",
        "inverted": "sample string 4",
        "markup": "sample string 5",
        "diffOverECB": "sample string 6",
        "markupOverECB": "sample string 7",
        "fcmid": "sample string 8",
        "fctid": "sample string 9"
      }
    },
    {
      "amount": {
        "value": "sample string 1",
        "fee": "sample string 2",
        "currency": {
          "code": "sample string 1",
          "numericCode": "sample string 2",
          "symbol": "sample string 3",
          "minorUnit": 4,
          "displayUnit": 5
        }
      },
      "rate": {
        "type": "sample string 1",
        "currency": {
          "code": "sample string 1",
          "numericCode": "sample string 2",
          "symbol": "sample string 3",
          "minorUnit": 4,
          "displayUnit": 5
        },
        "value": "sample string 2",
        "direct": "sample string 3",
        "inverted": "sample string 4",
        "markup": "sample string 5",
        "diffOverECB": "sample string 6",
        "markupOverECB": "sample string 7",
        "fcmid": "sample string 8",
        "fctid": "sample string 9"
      }
    }
  ],
  "messages": {
    "rateSource": "sample string 1",
    "disclaimer": "sample string 2",
    "optOutDisclaimer": "sample string 3"
  }
}