Transactions

1. Get transactions

Send an HTTP GET request to the relevant endpoint + /api/reconciliation/v1/merchant/sweeps/{sweepId}/transactions. You can use the same reconciliation token generated previously.

Request

cURL

curl --request GET \
     --url 'https://app.payvyne.com/api/v1/reconciliation/merchant/sweeps/<sweepId>/transactions' \
     --header 'Accept: application/json'

Parameter	Value
size	null
cursor	null

Response

cURL

{
    "elements": [{
        "transactionId": "52605040dbe60a74",
        "type": "PAYMENT",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {},
        "description": "Web payment",
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-01T00:00:00Z",
        "value": {
            "amount": 1000.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "65d50289aae86237",
        "type": "REFUND",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {
            "id": "52605040dbe60a74"
        },
        "description": "Refund for web payment",
        "createdAt": "2023-01-01T01:00:00Z",
        "updatedAt": "2023-01-01T01:00:00Z",
        "value": {
            "amount": -100.00,
            "currency": "GBP"
        }
    }, , {
        "transactionId": "99d50289da123239",
        "type": "PAYOUT",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {},
        "description": "Payout",
        "createdAt": "2023-01-01T02:00:00Z",
        "updatedAt": "2023-01-01T02:00:00Z",
        "value": {
            "amount": -100.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "e6e005426b2d43eb",
        "type": "FEE",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {
            "id": "52605040dbe60a74"
        },
        "description": "Fee for web payment",
        "createdAt": "2023-01-01T03:00:00Z",
        "updatedAt": "2023-01-01T03:00:00Z",
        "value": {
            "amount": 1.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "08373758bb98519c",
        "type": "TOP-UP",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {},
        "description": "Top up",
        "createdAt": "2023-01-01T04:00:00Z",
        "updatedAt": "2023-01-01T04:00:00Z",
        "value": {
            "amount": 200.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "e6e005426b2d43eb",
        "type": "MISCELLANEOUS-RETURN",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {},
        "description": "Fee for web payment",
        "createdAt": "2023-01-01T05:00:00Z",
        "updatedAt": "2023-01-01T05:00:00Z",
        "value": {
            "amount": -300.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "30ef409572553489",
        "type": "MISCELLANEOUS-PAYMENT",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {},
        "description": "Fee for web payment",
        "createdAt": "2023-01-01T07:00:00Z",
        "updatedAt": "2023-01-01T07:00:00Z",
        "value": {
            "amount": 300.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "21ad347572752249",
        "type": "TRANSFERRED-AMOUNT",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {},
        "description": "Fee for web payment",
        "createdAt": "2023-01-01T08:00:00Z",
        "updatedAt": "2023-01-01T08:00:00Z",
        "value": {
            "amount": -1001.00,
            "currency": "GBP"
        }
    }],
    "previousPage": null,
    "nextPage": "eyJ0eXBlIjoiUEZDIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjAtMDYtMTVUMTk6MjI6MTYuMjgzWiIsInBheW1lbnRJZCI6IjcyOGYxOTQwM2QxMTA0YTEifQ==",
    "size": 8
}

📘

Helpful to know

For the next set of results, set the cursor query parameter to the value of nextPage from the response.