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
andpagenumber
query parameters - Properties that were removed from response body:
merchantId
merchantName
- Properties that were renamed in response body:
paymentPoints[i].paymentPointId
topaymentPoints[i].id
paymentPoints[i].paymentPointName
topaymentPoints[i].name
Transfer referencesโ
GET /transaction-reporting/api/merchant/v1/paymentpoints/{paymentpointid}/transfer-references
This endpoint is replaced by:
List of breaking changesโ
- Paging was implemented with new
pagesize
andpagenumber
query parameters - Properties that were renamed in response body:
transferReferences[i].transferReference
totransfers[i].reference
transferReferences[i].transferReferenceDate
totransfers[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 tostartdate
to
was renamed toenddate
- 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:
List of breaking changesโ
Paging was implemented with new
pagesize
andpagenumber
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 totransactions[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 tostartdate
to
was renamed toenddate
pageToken
removed
Transferred transactionsโ
/transaction-reporting/api/merchant/v1/paymentpoints/{paymentpointid}/transfers/{transferreference}
This endpoint was deprecated.
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:
List of breaking changesโ
- Paging was implemented with new
pagesize
andpagenumber
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 tostartdate
to
was renamed toenddate
transaction[i].transferReferenceDate
was renamed totransactions[i].transferDate
transaction[i].merchantPayerReference
was renamed totransactions[i].agreementExternalId
pageToken
was removed
Transferred transactionsโ
GET /transaction-reporting/api/merchant/v2/paymentpoints/{paymentpointid}/transfers/{transferreference}
This endpoint was deprecated.
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.
You could achieve similar results with the new transfers endpoint, more information here.