3. Transfer Estimation

  • Introduction:
    This API estimates cross-border transfer details, including the expected received amount, FX rate, and detailed fees.

  • Endpoint: /v1/transfer/estimate

  • Method: POST

Request

Field Type Required Description
amount Number Y The amount to transfer.
payerCurrency String Y ISO 4217 currency code of the payer (e.g. BRL).
payerAccountId String Y Identifier of the payer's account.
beneficiaryCurrency String Y ISO 4217 currency code of the beneficiary (e.g. USD).
beneficiaryAccountId String Y Identifier of the beneficiary's account.
transferPlan String Y Selected transfer plan (e.g. standard).
merchantTranId String Y Unique merchant transaction identifier.

Example Request

{
  "amount": 100.5,
  "payerCurrency": "BRL",
  "payerAccountId": "string",
  "beneficiaryCurrency": "USD",
  "beneficiaryAccountId": "string",
  "transferPlan": "standard",
  "merchantTranId": "string"
}

Response

Field Type Description
merchantTranId String The merchant transaction identifier.
transferId String The session identifier for this transfer calculation.
expiredTime String ISO 8601 timestamp indicating when the calculation expires.
estReceiveAmount Number Estimated amount the beneficiary will receive.
estReceiveCurrency String ISO 4217 currency code of the estimated received amount.
estFundArrivalTime String Estimated fund arrival notation (e.g. T0).
estFxPrice Number Estimated foreign exchange rate.
tradingPair String Currency pair code (e.g. BRLUSD).
fees Array An array of fee breakdown objects.
estReceiveAestTotalFeemount Number Estimated fee amount
estTotalFeeCurrency String Estimated fee currency

Fees Object Format

{
  "feeType": "swiftFee",
  "feeAmount": 100,
  "feeCurrency": "USD"
}

Example Response

{
  "status": 200,
  "code": null,
  "msg": "OK",
  "data": {
    "merchantTranId": "string",
    "transferId": "string",
    "expiredTime": "2025-06-19T00:00:00Z",
    "estReceiveAmount": 123456.12,
    "estReceiveCurrency": "USD",
    "estFundArrivalTime": "T0",
    "estFxPrice": 0.18,
    "tradingPair": "BRLUSD",
    "estTotalFee": "207.89",
    "estTotalFeeCurrency": "USD",
    "fees": [
      {
        "feeType": "swiftFee",
        "feeAmount": 100,
        "feeCurrency": "USD"
      },
      {
        "feeType": "ourFee",
        "feeAmount": 107.89,
        "feeCurrency": "USD"
      }
    ]
  },
  "traceId": "Auto:75f476b99c26423d93c93682dd4ce030"
}

Error Response

If the request is invalid or fails business validation, an error is returned:

{
  "status": 400,
  "code": "XFER0001",
  "msg": "Missing required field: amount",
  "traceId": "e8b6f3c4-1a2d-4f5e-b678-1234567890ab"
}
code msg Meaning
XFER0001 Missing required field: amount One of the required fields was not provided.
XFER0002 Invalid payerCurrency: XXX The specified payerCurrency is not supported.
XFER0000 Internal server error An unexpected error occurred—please retry or contact support.

results matching ""

    No results matching ""