Reporting overview

Vyne makes makes reporting and reconciliation seamless for both merchants and partners by offering a number of Reporting API endpoints which allow transactional data to be queried. Vyne allows for 4 endpoints to be queried.

Transaction type

Description

Single payments

All single payment records that were created by raising a PIRPIR - Payment Initiation Request.

Refunds

All refund records that were created by raising a RRRR - Refund Request.

Payouts

All payout records that were created by raising a PRPR - Payout Request.

Sweeps

All records of automatic payments made from settlement accounts to merchant treasury bank accounts. More information on accounts here.

In order to receive the desired data via the reporting API, merchants and partner must complete 2 steps.

1. Get reporting token

Start by generating a reporting token. Make a HTTP POST request to the relevant endpoint + /api/oauth/token/ using the access token you generated. Remember to use a Reporting access token.

Request

curl --location --request POST 'https://uat.app.payvyne.com/api/oauth/token' 
--header 'Content-Type: application/x-www-form-urlencoded' 
--data-urlencode 'grant_type=client_credentials' 
--data-urlencode 'client_id=<reporting_key>'
--data-urlencode 'client_secret=<reporting_secret>’

👍

Try it out

If your request was successful you will receive a reporting token like this in the response eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudElkIjoxLCJzY29wZSI6WyJwYXkiXSwiaXNzIjoiaHR0cDovL2FwcC5kZXYucGF5dnluZS5zeXN0ZW1zIiwiZXhwIjoxNTg2MzY5NzExLCJpYXQiOjE1ODYzNjYxMTEsImF1dGhvcml0aWVzIjpbIlJPTEVfUEFZIl0sImp0aSI6ImExY2UzZjdmLTE3MzItNDhmNC04NTI3LTA5NWQ5NjlhNjkzNSIsImNsaWVudF9pZCI6IllNUFE2aDZQYTNaYmpEMXplbkQ0eXcifQ.g3XSXftyHvlCL1z1tlW6khboY7hzbiZVZgIzKHF2Rdc

2. Query the API

Then, query the API. Send an HTTP GET request the relevant endpoint, specifying the query parameters that you desire. There are 3 optional query parameters that can be specified when making this request:

Parameter

Description

Default

query

Query for filtering between payments. Specifications of the transaction records to be returned.

Will not filter transactional records in any way.

size

The maximum amount of transactions to be provided per page. This can be between 1 and 1000 transactions.

20

cursor

Pointer to the requested page. Important for retrieving all data when total report is more than 1 page.

Will return the data for page 1 of the report.

📘

Building the query

It is possible to specify the data to be included in the query response by detailing what criteria any of parameters of the returned transactions must meet. Information on the operators that can be used can be found here.

To find details of the API endpoints that merchants should make requests to for each transaction type please go here.

To find details of the API endpoints that partners should make requests to for each transaction type please go here.


Did this page help you?