GuidesAPI ReferenceHelp Centre
payvyne.comLog In

Report single payments

Suggest Edits

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://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>’

2. Get single payments

Send an HTTP GET request to the relevant endpoint + /api/reporting/v1/payments/merchant and include any required query parameters in the request.

Single payment queries can contain the following terms:

  • id
  • amount
  • currency
  • status
  • createdAt
  • destinationAccountIdentifier
  • merchantReference
  • customerReference

Request

curl --request GET \
     --url 'http://app.payvyne.com/api/reporting/v1/payments/merchant?size=2&query=currency%20%3D%20%E2%80%98GBP%E2%80%99%20AND%20amount%20%3E%2010%20AND%20status%20%3D%20%E2%80%98SETTLED%E2%80%99'\
     --header 'Accept: application/json'
ParameterValue
size2
querycurrency = ‘GBP’ AND amount > 10.00 AND status = ‘SETTLED’
cursorNull

🚧

Be aware

The queries specified in your GET request requires URL encoding.

Response

{
    "elements": [
        {
            "id": "f821233fc716ffe4",
            "amount": "21.00",
            "currency": "GBP",
            "description": "Web payment",
            "status": "SETTLED",
            "type": "ONE_OFF",
            "createdAt": "2020-05-15T13:47:56.305Z",
            "updatedAt": "2020-07-06T13:58:07.632Z",
            "destinationAccountName": "Megashop Ltd",
            "destinationAccountIdentifier": "GBP1",
            "initiator": "VYNE_MERCHANT"
        },
        {
            "id": "728f19403d1104a1",
            "amount": "12.00",
            "currency": "GBP",
            "description": "Example website",
            "status": "SETTLED",
            "type": "ONE_OFF",
            "createdAt": "2020-06-15T19:22:16.283Z",
            "updatedAt": "2020-07-06T13:58:07.631Z",
            "destinationAccountName": "Megashop Ltd",
            "destinationAccountIdentifier": "GBP1",
            "initiator": "VYNE_MERCHANT"
        }
    ],
    "nextPage": "eyJ0eXBlIjoiUEZDIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjAtMDYtMTVUMTk6MjI6MTYuMjgzWiIsInBheW1lbnRJZCI6IjcyOGYxOTQwM2QxMTA0YTEifQ==",
    "size": 2
}

Updated 2 months ago