Merchant reporting

📘

Building queries

The queries specified in your GET calls require URL encoding.

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 payments queries can be filtered on the following details:

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

Request

The below example shows a request with the following details:

Parameter

Value

size

2

query

currency = ‘GBP’ AND amount > 10.00 AND status = ‘SETTLED’

cursor

Null

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'

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": "Sample Web app with QR code",
            "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
}

Refunds

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

Refund queries can be filtered on the following details:

  • id
  • paymentId
  • currency
  • amount
  • status
  • createdAt

Request

The below example shows a request with the following details:

Parameter

Value

size

40

query

currency = ‘GBP’ AND amount < 1.00 AND status = ‘FAILED’

cursor

Null

curl --request GET \
     --url 'http://app.payvyne.com/api/reporting/v1/refunds/merchant?size=40&query=currency%20%3D%20%E2%80%98GBP%E2%80%99%20AND%20amount%20%3C%201%20AND%20status%20%3D%20%E2%80%98FAILED%E2%80%99' \
     --header 'Accept: application/json'

Response

{
    "elements": [
        {
            "id": "e6e005426b2d43eb",
            "paymentId": "910c40aa1423ff42",
            "amount": "0.40",
            "createdAt": "2022-05-17T15:25:43.361Z",
            "status": "FAILED",
            "initiator": "VYNE_MERCHANT",
            "initiatorId": "da98bd3a4bd2b9c7",
            "accountNumber": "63849203",
            "currency": "GBP",
            "sortCode": "001111",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a"
        },
        {
            "id": "d26600a5987f7515",
            "paymentId": "0d7819fed2e2e0de",
            "amount": "0.40",
            "createdAt": "2022-05-17T15:34:11.077Z",
            "status": "FAILED",
            "initiator": "VYNE_MERCHANT",
            "initiatorId": "da98bd3a4bd2b9c7",
            "accountNumber": "63849203",
            "currency": "GBP",
            "sortCode": "001111",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a"
        },
        {
            "id": "08373758bb98519c",
            "paymentId": "0d7819fed2e2e0de",
            "amount": "0.10",
            "createdAt": "2022-05-18T10:48:41.571Z",
            "status": "FAILED",
            "initiator": "VYNE_MERCHANT",
            "initiatorId": "da98bd3a4bd2b9c7",
            "accountNumber": "63849203",
            "currency": "GBP",
            "sortCode": "001111",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a"
        }
    ],
    "size": 3
}

Payouts

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

Payout queries can be filtered on the following details:

  • id
  • currency
  • amount
  • status
  • createdAt

Request

The below example shows a request with the following details:

Parameter

Value

size

50

query

status = 'COMPLETED'

cursor

Null

curl --request GET \
     --url 'http://app.payvyne.com/api/reporting/v1/payouts/merchant?size=50&query=status%20%3D%20%27COMPLETED%27' \
     --header 'Accept: application/json'

Response

{
    "elements": [
        {
            "id": "c28dd2a4ef2bed73",
            "amount": "12.50",
            "currency": "GBP",
            "status": "COMPLETED",
            "createdAt": "2021-09-22T07:44:15.372Z",
            "updatedAt": "2021-09-22T07:45:01.311Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "payerId": "4d2e6129-2efd-3c73-ac63-7bcbf9ebc98e"
        },
        {
            "id": "52605040dbe60a74",
            "amount": "1.00",
            "currency": "GBP",
            "status": "COMPLETED",
            "createdAt": "2021-09-22T07:47:42.658Z",
            "updatedAt": "2021-09-22T07:48:01.693Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "payerId": "4d2e6129-2efd-3c73-ac63-7bcbf9ebc98e"
        },
        {
            "id": "65d50289aae86237",
            "amount": "9.70",
            "currency": "GBP",
            "status": "COMPLETED",
            "createdAt": "2022-04-11T10:12:37.161Z",
            "updatedAt": "2022-04-11T10:13:02.498Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "payerId": "2b664cdf-e865-3b68-a050-b3afcb4f654d"
        }
    ],
    "size": 3
}

Sweeps

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

Sweep queries can be filtered on the following details:

  • id
  • currency
  • amount
  • status
  • createdAt
  • settlementAccountIdentifier

Request

The below example shows a request with the following details:

Parameter

Value

size

4

query

settlementAccountIdentifier = 'GBP3'

cursor

Null

curl --request GET \
     --url 'http://app.payvyne.com/api/reporting/v1/sweeps/merchant?size=4&query=settlementAccountIdentifier%20%3D%20%27GBP3%27' \
     --header 'Accept: application/json'

Response

{
    "elements": [
        {
            "id": "PAYOUT-30ef409572553489",
            "createdAt": "2021-08-18T20:20:20.361Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "settlementAccountBalancePreSweep": "322.85"         
            "minReserveAmount": "200"          
            "amount": "122.85",        
            "destinationAccountName": "Megashop Ltd",
            "destinationAccountId": "GBP1",
            "currency": "GBP",
            "status": "COMPLETED"
        },
        {
            "id": "PAYOUT-aaba45c9c0b30611",
            "createdAt": "2021-08-19T20:20:20.261Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "settlementAccountBalancePreSweep": "203.65"          
            "minReserveAmount": "200"          
            "amount": "3.65",
            "destinationAccountName": "Megashop Ltd",
            "destinationAccountId": "GBP1",
            "currency": "GBP",
            "status": "COMPLETED"
        },
        {
            "id": "b226f2c6a7c039b6",
            "createdAt": "2021-12-11T20:20:20.769Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "settlementAccountBalancePreSweep": "2200.00"          
            "minReserveAmount": "200.00"          
            "amount": "2000.00",
            "destinationAccountName": "Megashop London Ltd",
            "destinationAccountId": "GBP1",
            "currency": "GBP",
            "status": "COMPLETED"
        },
        {
            "id": "9609edeb43c38414",
            "createdAt": "2021-12-12T20:20:20.529Z",
            "settlementAccountIdentifier": "GBP3",
            "settlementAccountName": "Megashop",
            "settlementAccountBalancePreSweep": "201"
            "minReserveAmount": "200"          
            "amount": "1.00",
            "destinationAccountName": "Megashop London Ltd",
            "destinationAccountId": "GBP1",
            "currency": "GBP",
            "status": "FAILED"
        }
    ],
    "nextPage": "eyJ0eXBlIjoiU1dQIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjEtMTItMTJUMjA6MjA6MjAuNTI5WiIsInN3ZWVwSWQiOiI5NjA5ZWRlYjQzYzM4NDE0In0=",
    "size": 4
}

Did this page help you?