Report single payments

1. 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. You can use the same reporting token generated previously.

Single payment queries can contain the following terms:

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

Request

cURL

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'

Parameter	Value
size	2
query	currency = ‘GBP’ AND amount > 10.00 AND status = ‘SETTLED’
cursor	Null

🚧

Be aware

The queries specified in your GET request requires URL encoding.

Response

JSON

{
    "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
}