Retrieve rate details.

GET 
/currencies/entities/{processing-entity-id}/rates

Retrieves the rate details of a given processing entity according to the provided set of parameters.

Request

Path Parameters

processing-entity-id uuidrequired

ID of Processing Entity.

Query Parameters

from_currency Currencyrequired
Possible values: >= 3 characters and <= 3 characters
Mandatory. Single value. The original merchant currency.
Example: USD
to_currencies Currency[]
Possible values: >= 1
Optional. The list of target currencies, separated by commas. If not supplied, all the merchant site-related currencies are retrieved.
Example: [EUR, CAD]
payment_methods PaymentMethod[]required
Possible values: >= 1
Mandatory. A comma-separated list of payment method names.
Example: [CARD, ACH]
rate_type RateType
Possible values: [payment, payout, masterCardPayout]
The Values are: payment (default), payout (brings Visa rates), masterCardpayout (brings MC rates)
Default value: payment

Responses

200

OK

application/json

Schema

Schema

rates

object[]

Collection of result rates for the rates. An array of complex items, each array item is a collection of values.

Array [

paymentMethod PaymentMethod (string)

The name of the payment method. 'CARD' for credit cards; other names for alternative payment methods.

fromCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

toCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

rate RateValue (number)required

A value of rate. May have many digits after decimal point.

Example: 2.48590452

]

rate_type RateType (string)
Possible values: [payment, payout, masterCardPayout]
Default value: payment

result

object

required

status stringrequired

Possible values: [error, success]

errors

object

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "rates": [
    {
      "paymentMethod": "string",
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 2.48590452
    }
  ],
  "rate_type": "payment",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Card USD to EUR and BGN Rates

Exchange rates for credit cards for USD to EUR and BGN

{
  "rates": [
    {
      "paymentMethod": "CARD",
      "fromCurrency": "USD",
      "toCurrency": "EUR",
      "rate": 0.928821
    },
    {
      "paymentMethod": "CARD",
      "fromCurrency": "USD",
      "toCurrency": "BGN",
      "rate": 1.816942
    }
  ],
  "result": {
    "status": "success"
  }
}

Card and ACH USD to EUR Rates

Exchange rates for credit cards and ACH for USD to EUR

{
  "rates": [
    {
      "paymentMethod": "CARD",
      "fromCurrency": "USD",
      "toCurrency": "EUR",
      "rate": 0.928824
    },
    {
      "paymentMethod": "ACH",
      "fromCurrency": "USD",
      "toCurrency": "EUR",
      "rate": 0.919931
    }
  ],
  "result": {
    "status": "success"
  }
}

400

Bad Request

application/json

Schema

Schema

rates

object[]

Collection of result rates for the rates. An array of complex items, each array item is a collection of values.

Array [

paymentMethod PaymentMethod (string)

The name of the payment method. 'CARD' for credit cards; other names for alternative payment methods.

fromCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

toCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

rate RateValue (number)required

A value of rate. May have many digits after decimal point.

Example: 2.48590452

]

rate_type RateType (string)
Possible values: [payment, payout, masterCardPayout]
Default value: payment

result

object

required

status stringrequired

Possible values: [error, success]

errors

object

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "rates": [
    {
      "paymentMethod": "string",
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 2.48590452
    }
  ],
  "rate_type": "payment",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Missing Mandatory Field Value

{
  "result": {
    "status": "error",
    "errors": {
      "code": "5000.1000",
      "reason": "[processingEntityId] must not be null"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

rates

object[]

Collection of result rates for the rates. An array of complex items, each array item is a collection of values.

Array [

paymentMethod PaymentMethod (string)

The name of the payment method. 'CARD' for credit cards; other names for alternative payment methods.

fromCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

toCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

rate RateValue (number)required

A value of rate. May have many digits after decimal point.

Example: 2.48590452

]

rate_type RateType (string)
Possible values: [payment, payout, masterCardPayout]
Default value: payment

result

object

required

status stringrequired

Possible values: [error, success]

errors

object

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "rates": [
    {
      "paymentMethod": "string",
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 2.48590452
    }
  ],
  "rate_type": "payment",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Authorization Error

Authorization error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "7300.3000",
      "reason": "Authorization error."
    }
  }
}

403

Forbidden

application/json

Schema

Schema

rates

object[]

Collection of result rates for the rates. An array of complex items, each array item is a collection of values.

Array [

paymentMethod PaymentMethod (string)

The name of the payment method. 'CARD' for credit cards; other names for alternative payment methods.

fromCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

toCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

rate RateValue (number)required

A value of rate. May have many digits after decimal point.

Example: 2.48590452

]

rate_type RateType (string)
Possible values: [payment, payout, masterCardPayout]
Default value: payment

result

object

required

status stringrequired

Possible values: [error, success]

errors

object

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "rates": [
    {
      "paymentMethod": "string",
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 2.48590452
    }
  ],
  "rate_type": "payment",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Authorization Error

Authorization error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "7300.3000",
      "reason": "Authorization error."
    }
  }
}

404

Not Found

application/json

Schema

Schema

rates

object[]

Collection of result rates for the rates. An array of complex items, each array item is a collection of values.

Array [

paymentMethod PaymentMethod (string)

The name of the payment method. 'CARD' for credit cards; other names for alternative payment methods.

fromCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

toCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

rate RateValue (number)required

A value of rate. May have many digits after decimal point.

Example: 2.48590452

]

rate_type RateType (string)
Possible values: [payment, payout, masterCardPayout]
Default value: payment

result

object

required

status stringrequired

Possible values: [error, success]

errors

object

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "rates": [
    {
      "paymentMethod": "string",
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 2.48590452
    }
  ],
  "rate_type": "payment",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Not Found Error

Not found error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "9100.1005",
      "reason": "Not found"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

rates

object[]

Collection of result rates for the rates. An array of complex items, each array item is a collection of values.

Array [

paymentMethod PaymentMethod (string)

The name of the payment method. 'CARD' for credit cards; other names for alternative payment methods.

fromCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

toCurrency Currency (string)required

The 3-letter ISO currency code.

Possible values: >= 3 characters and <= 3 characters

rate RateValue (number)required

A value of rate. May have many digits after decimal point.

Example: 2.48590452

]

rate_type RateType (string)
Possible values: [payment, payout, masterCardPayout]
Default value: payment

result

object

required

status stringrequired

Possible values: [error, success]

errors

object

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "rates": [
    {
      "paymentMethod": "string",
      "fromCurrency": "string",
      "toCurrency": "string",
      "rate": 2.48590452
    }
  ],
  "rate_type": "payment",
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Internal Processing Error

Internal processing error

{
  "result": {
    "status": "error",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error."
    }
  }
}

Loading...