Partner 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/partner 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
  • merchantId
  • merchantReference
  • customerReference

Request

The below example shows a request with the following details:

Parameter

Value

size

3

query

currency = ‘GBP’ AND status = ‘FAILED’

cursor

Null

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

Response

{
    "elements": [
        {
            "id": "a5ad103f86982f9f",
            "amount": "2.00",
            "currency": "GBP",
            "description": "Intial deposit",
            "status": "FAILED",
            "createdAt": "2022-04-19T12:42:57.987Z",
            "updatedAt": "2022-04-19T12:45:01.624Z",
            "bankName": "Diamond bank",
            "bankId": "test_diamond",
            "destinationAccountName": "report1 LTD",
            "destinationAccountIdentifier": "GBP2",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a",
            "initiator": "VYNE_MERCHANT"
        },
        {
            "id": "8ccbddb799c20016",
            "amount": "200.00",
            "currency": "GBP",
            "description": "Full payment",
            "status": "FAILED",
            "createdAt": "2022-04-19T13:15:47.691Z",
            "updatedAt": "2022-04-19T13:18:02.643Z",
            "bankName": "Diamond bank",
            "bankId": "test_diamond",
            "destinationAccountName": "report1 LTD",
            "destinationAccountIdentifier": "GBP2",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a",
            "initiator": "VYNE_MERCHANT"
        },
        {
            "id": "945e74e98b53a4ec",
            "amount": "259.00",
            "currency": "GBP",
            "description": "Full payment",
            "status": "FAILED",
            "createdAt": "2022-04-19T14:06:50.961Z",
            "updatedAt": "2022-04-19T14:08:10.702Z",
            "bankName": "Diamond bank",
            "bankId": "test_diamond",
            "destinationAccountName": "report1 LTD",
            "destinationAccountIdentifier": "GBP2",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a",
            "initiator": "VYNE_MERCHANT"
        }
    ],
    "nextPage": "eyJ0eXBlIjoiUEZDIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjItMDQtMTlUMTQ6MDY6NTAuOTYxWiIsInBheW1lbnRJZCI6Ijk0NWU3NGU5OGI1M2E0ZWMifQ==",
    "size": 3
}

Refunds

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

Refund queries can be filtered on the following details:

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

Request

The below example shows a request with the following details:

Parameter

Value

size

2

query

merchantId = ‘report1 LTD’

cursor

Null

curl --request GET \
     --url 'http://app.payvyne.com/api/reporting/v1/refunds/partner?size=2&query=merchantId%20%3D%20%E2%80%98report1%20LTD%E2%80%99' \
     --header 'Accept: application/json'

Response

{
    "elements": [
        {
            "id": "f3b2216bce1615f9",
            "paymentId": "a5ad103f86982f9f",
            "amount": "1672.00",
            "createdAt": "2022-04-19T12:43:20.993Z",
            "status": "FAILED",
            "initiator": "VYNE_MERCHANT",
            "initiatorId": "bbaa18a37ad6b0c3",
            "merchantId": "bbaa18a37ad6b0c3",
            "accountNumber": "63849203",
            "merchantName": "report1 LTD",
            "currency": "GBP",
            "sortCode": "001111",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a"
        },
        {
            "id": "0bf49cb8d4db8964",
            "paymentId": "945e74e98b53a4ec",
            "amount": "62.00",
            "createdAt": "2022-04-19T14:07:14.073Z",
            "status": "SETTLED",
            "initiator": "VYNE_MERCHANT",
            "initiatorId": "bbaa18a37ad6b0c3",
            "merchantId": "bbaa18a37ad6b0c3",
            "accountNumber": "63849203",
            "merchantName": "report1 LTD",
            "currency": "GBP",
            "sortCode": "001111",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a"
        }
    ],
    "nextPage": "eyJ0eXBlIjoiUkZDIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjItMDQtMTlUMTQ6MDc6MTQuMDczWiIsInJlZnVuZElkIjoiMGJmNDljYjhkNGRiODk2NCJ9",
    "size": 2
}

Payouts

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

Payout queries can be filtered on the following details:

  • id
  • currency
  • amount
  • status
  • createdAt
  • merchantId

Request

The below example shows a request with the following details:

Parameter

Value

size

10

query

id = 'd5de72a108ba0954'

cursor

Null

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

Response

{
    "elements": [
        {
            "id": "d5de72a108ba0954",
            "amount": "22.00",
            "currency": "GBP",
            "status": "COMPLETED",
            "createdAt": "2022-05-04T13:56:06.756Z",
            "updatedAt": "2022-05-04T13:57:02.392Z",
            "settlementAccountIdentifier": "GBP2",
            "settlementAccountName": "report1 LTD",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "payerId": "cc858257-f778-51ed-9c89-8d28dd30ea1a"
        }
    ],
    "size": 1
}

Sweeps

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

Sweep queries can be filtered on the following details:

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

Request

The below example shows a request with the following details:

Parameter

Value

size

10

query

createdAt > '2022-04-20T00:00:00Z'

cursor

Null

curl --request GET \
     --url 'http://app.payvyne.com/api/reporting/v1/sweeps/partner?size=20&query=createdAt%20%3E%20%272022-04-20T00%3A00%3A00Z%27' \
     --header 'Accept: application/json'

Response

{
    "elements": [
        {
            "id": "cd2c94f6b61621ff",
            "createdAt": "2022-04-20T20:20:35.571Z",
            "settlementAccountIdentifier": "GBP2",
            "settlementAccountName": "report1 LTD",
            "settlementAccountBalancePreSweep": "2.00",
            "minReserveAmount": "0.00",
            "amount": "2.00",
            "destinationAccountName": "HSBC UK - London",
            "destinationAccountId": "GBP1",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "currency": "GBP",
            "status": "FAILED"
        },
        {
            "id": "3503fe803f2d9f15",
            "createdAt": "2022-04-21T20:20:38.140Z",
            "settlementAccountIdentifier": "GBP2",
            "settlementAccountName": "report1 LTD",
            "settlementAccountBalancePreSweep": "146.00",
            "minReserveAmount": "0.00",
            "amount": "146.00",
            "destinationAccountName": "HSBC UK - London",
            "destinationAccountId": "GBP1",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "currency": "GBP",
            "status": "FAILED"
        },
        {
            "id": "2b4ae33d6995eb4f",
            "createdAt": "2022-04-28T20:20:35.470Z",
            "settlementAccountIdentifier": "GBP2",
            "settlementAccountName": "report1 LTD",
            "settlementAccountBalancePreSweep": "726.00",
            "minReserveAmount": "0.00",
            "amount": "726.00",
            "destinationAccountName": "HSBC UK - London",
            "destinationAccountId": "GBP1",
            "merchantName": "report1 LTD",
            "merchantId": "bbaa18a37ad6b0c3",
            "currency": "GBP",
            "status": "FAILED"
        }
    ],
    "nextPage": "eyJ0eXBlIjoiU1dQIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjItMDQtMjhUMjA6MjA6MzUuNDdaIiwic3dlZXBJZCI6IjJiNGFlMzNkNjk5NWViNGYifQ==",
    "size": 3
}

Did this page help you?