Report payouts

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

2. Return 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 contain the following terms:

  • id
  • currency
  • amount
  • status
  • createdAt

Request

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'

🚧

Be aware

The queries specified in your GET request requires URL encoding.

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
}

Did this page help you?