Partner reconciliation

Sweeps

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

Sweep queries can contain the following terms:

• merchantId
• createdAt
• settlementAccountIdentifier

Request

cURL

curl --request GET \
     --url 'https://app.payvyne.com/api/v1/reconciliation/partner/sweeps?size=2&query=%28createdAt%20%3E%3D%20%272023-01-01%27%20AND%20createdAt%20%3C%3D%20%272023-03-20%27%29%20AND%20settlementAccountIdentifier%20%3D%20%27GBP3%27%20AND%20merchantId%20%3D%20%271%27' \
     --header 'Accept: application/json'

Parameter	Value
size	2
query	(createdAt >= '2023-01-01' AND createdAt <= '2023-03-20') AND settlementAccountIdentifier = 'GBP3'
cursor	Null

Response

cURL

{
    "elements": [{
        "id": "a5ad103f86982f9f",
        "merchant": {
            "id": "945e74e98b53a4ec"
        },
        "settlementAccount": {
            "identifier": "GBP1"
        },
        "openingBalance": {
            "amount": 10.00,
            "currency": "GBP"
        },
        "closingBalance": {
            "amount": 10.00,
            "currency": "GBP"
        },
        "reservedBalance": {
            "amount": 10.00,
            "currency": "GBP"
        },
        "transferredAmount": {
            "amount": 100.00,
            "currency": "GBP"
        },
        "summary": {
            "payments": {
                "value": {
                    "amount": 100.00,
                    "currency": "GBP"
                },
                "count": 10
            },
            "refunds": {
                "value": {
                    "amount": 10.00,
                    "currency": "GBP"
                },
                "count": 1
            },
            "payouts": {
                "value": {
                    "amount": 10.00,
                    "currency": "GBP"
                },
                "count": 1
            },
            "fees": {
                "value": {
                    "amount": 10.00,
                    "currency": "GBP"
                },
                "count": 10
            },
            "topUps": {
                "value": {
                    "amount": 30.00,
                    "currency": "GBP"
                },
                "count": 1
            },
            "miscellaneous": {
                "value": {
                    "amount": 0.00,
                    "currency": "GBP"
                },
                "count": 0
            }
        },
        "createdAt": "2023-01-01T23:59:00Z",
        "updatedAt": "2023-01-01T23:59:00Z"
    }, {
        "id": "8ccbddb799c20016",
        "merchant": {
            "id": "bbaa18a37ad6b0c3"
        },
        "settlementAccount": {
            "identifier": "GBP1"
        },
        "openingBalance": {
            "amount": 10.00,
            "currency": "GBP"
        },
        "closingBalance": {
            "amount": 10.00,
            "currency": "GBP"
        },
        "reservedBalance": {
            "amount": 10.00,
            "currency": "GBP"
        },
        "transferredAmount": {
            "amount": 65.00,
            "currency": "GBP"
        },
        "summary": {
            "payments": {
                "value": {
                    "amount": 75.00,
                    "currency": "GBP"
                },
                "count": 5
            },
            "refunds": {
                "value": {
                    "amount": 5.00,
                    "currency": "GBP"
                },
                "count": 1
            },
            "payouts": {
                "value": {
                    "amount": 0.00,
                    "currency": "GBP"
                },
                "count": 0
            },
            "fees": {
                "value": {
                    "amount": 5.00,
                    "currency": "GBP"
                },
                "count": 5
            },
            "topUps": {
                "value": {
                    "amount": 0.00,
                    "currency": "GBP"
                },
                "count": 0
            },
            "miscellaneous": {
                "value": {
                    "amount": 0.00,
                    "currency": "GBP"
                },
                "count": 1
            }
        },
        "createdAt": "2023-01-02T23:59:00Z",
        "updatedAt": "2023-01-02T23:59:00Z"
    }],
    "previousPage": null,
    "nextPage": "eyJ0eXBlIjoiUEZDIiwiY3Vyc29yRGlyIjoiTkVYVCIsImNyZWF0ZWRBdCI6IjIwMjAtMDYtMTVUMTk6MjI6MTYuMjgzWiIsInBheW1lbnRJZCI6IjcyOGYxOTQwM2QxMTA0YTEifQ==",
    "size": 2
}

📘

Helpful to know

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

Transactions

Send an HTTP GET request to the relevant endpoint + /api/reconciliation/v1/partner/sweeps/{sweepId}/transactions.

Request

cURL

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

Parameter	Value
size	null
cursor	null

Response

cURL

{
    "elements": [{
        "transactionId": "30ef409572553489",
        "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": "aaba45c9c0b30611",
        "type": "REFUND",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {
            "id": "30ef409572553489"
        },
        "description": "Refund for web payment",
        "createdAt": "2023-01-01T01:00:00Z",
        "updatedAt": "2023-01-01T01:00:00Z",
        "value": {
            "amount": -100.00,
            "currency": "GBP"
        }
    }, , {
        "transactionId": "b226f2c6a7c039b6",
        "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": "d26600a5987f7515",
        "type": "FEE",
        "customerReference": "Customer Reference",
        "merchantReference": "Merchant Reference",
        "relatedTransaction": {
            "id": "30ef409572553489"
        },
        "description": "Fee for web payment",
        "createdAt": "2023-01-01T03:00:00Z",
        "updatedAt": "2023-01-01T03:00:00Z",
        "value": {
            "amount": 1.00,
            "currency": "GBP"
        }
    }, {
        "transactionId": "0d7819fed2e2e0de",
        "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": "c28dd2a4ef2bed73",
        "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": "0d7819fed2e2e0de",
        "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": "08373758bb98519c",
        "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.