Retrieve payments for a payout

Velo Payments Sandbox for testing

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

GET

/v3/payouts/{payoutId}/payments

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v3/payouts//payments'

Response Example

200 - Example 1

{
    "content": [
        {
            "amount": 1234,
            "currency": "USD",
            "payee": {
                "company": {
                    "companyName": "ACME Anvils PLC"
                },
                "individual": {
                    "name": {
                        "firstName": "Fred",
                        "lastName": "Flintstone"
                    }
                },
                "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            },
            "paymentId": "paymentId",
            "paymentMemo": "Payment memo",
            "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
            "payorPaymentId": "paymenIdVal123123",
            "remoteId": "remoteIdVal123",
            "remoteSystemId": "Remote_System_Id_101234",
            "sourceAccountName": "Chase",
            "status": "SUBMITTED",
            "transmissionType": "ACH",
            "withdrawable": false
        },
        {
            "amount": 1234,
            "currency": "USD",
            "payee": {
                "company": {
                    "companyName": "ACME Anvils PLC"
                },
                "individual": {
                    "name": {
                        "firstName": "Fred",
                        "lastName": "Flintstone"
                    }
                },
                "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
            },
            "paymentId": "paymentId",
            "paymentMemo": "Payment memo",
            "paymentMetadata": "invoiceeId_123|abc001:12345|xyz002:4567",
            "payorPaymentId": "paymenIdVal123123",
            "remoteId": "remoteIdVal123",
            "remoteSystemId": "Remote_System_Id_101234",
            "sourceAccountName": "Chase",
            "status": "SUBMITTED",
            "transmissionType": "ACH",
            "withdrawable": false
        }
    ],
    "links": [
        {
            "href": "href",
            "rel": "rel"
        },
        {
            "href": "href",
            "rel": "rel"
        }
    ],
    "page": {
        "numberOfElements": 0,
        "page": 5,
        "pageSize": 5,
        "totalElements": 6,
        "totalPages": 1
    }
}

Request

Path Params

Query Params

Responses

🟢200Payments for payout

application/json

Body

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

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

Instruct Payout

Create a quote for the payout