Skip to main content

Migrate from v1 and v2

As the reporting evolves, APIs are periodically reorganized, upgraded and improved. When APIs evolve, the old API is deprecated and eventually removed. This page contains information you need to know when migrating from Transaction Reporting API (v1 and v2) to newer and more stable Reporting API v3.

Migration from V1 endpoints​

Payment points​

GET /transaction-reporting/api/merchant/v1/paymentpoints

This endpoint is replaced by:

GET v3/reporting/paymentpoints

List of breaking changes​

  • Paging was implemented with new pagesize and pagenumber query parameters
  • Properties that were removed from response body:
    • merchantId
    • merchantName
  • Properties that were renamed in response body:
    • paymentPoints[i].paymentPointId to paymentPoints[i].id
    • paymentPoints[i].paymentPointName to paymentPoints[i].name

Transfer references​

GET /transaction-reporting/api/merchant/v1/paymentpoints/{paymentpointid}/transfer-references

This endpoint is replaced by:

GET v3/reporting/transfers

List of breaking changes​

  • Paging was implemented with new pagesize and pagenumber query parameters
  • Properties that were renamed in response body:
    • transferReferences[i].transferReference to transfers[i].reference
    • transferReferences[i].transferReferenceDate to transfers[i].date
  • Request parameters that were changed:
    • paymentpointid - in the old version of the endpoint, this property was a path parameter, it has now been changed to the query parameter. So to get the same result as it was returned from an old endpoint, provide this query parameter.
    • from was renamed to startdate
    • to was renamed to enddate
  • Response was changed from a JSON array to a JSON object that contains an array

Transactions​

GET /transaction-reporting/api/merchant/v1/paymentpoints/{paymentpointid}/transactions

This endpoint is replaced by:

GET v3/reporting/transactions

List of breaking changes​

  • Paging was implemented with new pagesize and pagenumber query parameters.

  • Properties that were removed from response body

    • merchantId
    • merchantName
    • paymentPointId
    • paymentPointName
    • transferReference
    • transferReferenceDate
    • receiverAccount
    • transactions[i].paymentTransactionId
    • transactions[i].senderComment
    • transactions[i].externalTransactionId
    • transactions[i].externalBulkId
    • nextPageToken

  • Properties that were renamed:

    • transactions[i].transferReferenceDate renamed to transactions[i].transferDate

  • Request parameters that were changed

    • paymentpointid - in the old version of the endpoint, this property was a path parameter, it has now been changed to the query parameter. So to get same result as it was returned from old endpoint, provide this query parameter.
    • from was renamed to startdate
    • to was renamed to enddate
    • pageToken removed

Transferred transactions​

/transaction-reporting/api/merchant/v1/paymentpoints/{paymentpointid}/transfers/{transferreference}

This endpoint was deprecated.

tip

You could achieve similar results by using transferid in new transfers endpoint, more information here.

Migration from V2 endpoints​

Transactions​

/transaction-reporting/api/merchant/v2/paymentpoints/{paymentpointid}/transactions

This endpoint is replaced by:

GET v3/reporting/transactions

List of breaking changes​

  • Paging was implemented with new pagesize and pagenumber query parameters
  • Properties that were removed from response body
    • companyRegNo
    • merchantName
    • paymentPointId
    • paymentPointName
    • receiverAccount
    • transactions[i].userIndicator
    • nextPageToken
  • Request parameters that were changed:
    • paymentpointid - in the old version of the endpoint, this property was a path parameter, it has now been changed to the query parameter. So to get same result as it was returned from old endpoint, provide this query parameter.
    • from was renamed to startdate
    • to was renamed to enddate
    • transaction[i].transferReferenceDate was renamed to transactions[i].transferDate
    • transaction[i].merchantPayerReference was renamed to transactions[i].agreementExternalId
    • pageToken was removed

Transferred transactions​

GET /transaction-reporting/api/merchant/v2/paymentpoints/{paymentpointid}/transfers/{transferreference}

This endpoint was deprecated.

tip

You could achieve similar results by using transferid in new transfers endpoint, more information here.

Transferred transactions by merchant​

GET /transaction-reporting/api/merchant/v2/paymentpoints/transfers

This endpoint was deprecated.

tip

You could achieve similar results with the new transfers endpoint, more information here.