Get Payouts for Payor

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v4/paymentaudit/payouts

Get List of payouts for payor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v4/paymentaudit/payouts'

Response Example

200 - Example 1

{
    "content": [
        {
            "dateTime": "2000-01-23T04:56:07.000+00:00",
            "fxSummaries": [
                {
                    "creationDateTime": "2000-01-23T04:56:07.000+00:00",
                    "fundingStatus": "FUNDED",
                    "invertedRate": 123.23,
                    "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "rate": 123.23,
                    "status": "UNQUOTED",
                    "totalCost": 5,
                    "totalPaymentAmount": 34235
                },
                {
                    "creationDateTime": "2000-01-23T04:56:07.000+00:00",
                    "fundingStatus": "FUNDED",
                    "invertedRate": 123.23,
                    "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "rate": 123.23,
                    "status": "UNQUOTED",
                    "totalCost": 5,
                    "totalPaymentAmount": 34235
                }
            ],
            "instructedDateTime": "instructedDateTime",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payoutMemo": "payoutMemo",
            "sourceAccountSummary": [
                {
                    "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "totalCost": 3344
                },
                {
                    "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "totalCost": 3344
                }
            ],
            "submittedDateTime": "submittedDateTime",
            "totalIncompletePayments": 6,
            "totalPayments": 0,
            "totalReturnedPayments": 1,
            "totalWithdrawnPayments": 5,
            "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00"
        },
        {
            "dateTime": "2000-01-23T04:56:07.000+00:00",
            "fxSummaries": [
                {
                    "creationDateTime": "2000-01-23T04:56:07.000+00:00",
                    "fundingStatus": "FUNDED",
                    "invertedRate": 123.23,
                    "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "rate": 123.23,
                    "status": "UNQUOTED",
                    "totalCost": 5,
                    "totalPaymentAmount": 34235
                },
                {
                    "creationDateTime": "2000-01-23T04:56:07.000+00:00",
                    "fundingStatus": "FUNDED",
                    "invertedRate": 123.23,
                    "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "rate": 123.23,
                    "status": "UNQUOTED",
                    "totalCost": 5,
                    "totalPaymentAmount": 34235
                }
            ],
            "instructedDateTime": "instructedDateTime",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payoutMemo": "payoutMemo",
            "sourceAccountSummary": [
                {
                    "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "totalCost": 3344
                },
                {
                    "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "totalCost": 3344
                }
            ],
            "submittedDateTime": "submittedDateTime",
            "totalIncompletePayments": 6,
            "totalPayments": 0,
            "totalReturnedPayments": 1,
            "totalWithdrawnPayments": 5,
            "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00"
        }
    ],
    "links": [
        {
            "href": "href",
            "rel": "rel"
        },
        {
            "href": "href",
            "rel": "rel"
        }
    ],
    "page": {
        "numberOfElements": 0,
        "page": 5,
        "pageSize": 5,
        "totalElements": 6,
        "totalPages": 1
    }
}

Request

Query Params

Responses

🟢200Payor data found

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠401Invalid access token. May be expired or invalid

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:19

Get Payout Statistics

Get Payments for Payout