FOfonoa
Transactions

Get the rates of successful and errored transactions, plus the associated data points

Used to get the rates and number of successful and errored transactions.

get/v1/transactions/reporting-rate

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Query parameters

country_codestring

Search by transaction country code.

currency_codestring

Primary currency code of the transaction represented as ISO 4217 3 letter uppercase currency code e.g. USD.

date_fromstring

Search by transaction creation date - date from - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

date_tostring

Search by transaction creation date - date to - date and time in UTC in format RFC3339. e.g. 2022-03-31T23:59:59Z

decimal_amountsboolean

A flag to be used in a migration phase. It signals in which format amounts should be parsed. If true amounts are parsed as decimals, if false amounts are parsed as an integer representing the minor currency unit.

directionstring

Search by the Transaction direction, can either be inbound (RECEIVED) or outbound (SENT)

Response

Ok - transactions reporting rates successfully returned for the provided search criteria.

messagestring
statusstring

Example response

{
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.