V3 Get Payments for Payout

Deprecated

Velo Payments Sandbox for testing

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

GET

/v3/paymentaudit/payouts/{payoutId}

Deprecated (use /v4/paymentaudit/payouts/ instead)

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "content": [
        {
            "accountName": "My Account Name",
            "accountNumber": "123123232323",
            "countryCode": "US",
            "events": [
                {
                    "accountName": "My account",
                    "accountNumber": "123123123",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "DE89 3704 0044 0532 0130 00",
                    "paymentAmount": 1299,
                    "principal": "Prinicple example",
                    "routingNumber": "123123123",
                    "sourceAmount": 1299
                },
                {
                    "accountName": "My account",
                    "accountNumber": "123123123",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "DE89 3704 0044 0532 0130 00",
                    "paymentAmount": 1299,
                    "principal": "Prinicple example",
                    "routingNumber": "123123123",
                    "sourceAmount": 1299
                }
            ],
            "filenameReference": "file ref",
            "fundingStatus": "FUNDED",
            "iban": "DE89 3704 0044 0532 0130 00",
            "individualIdentificationNumber": "1231231adf",
            "invertedRate": 1.4658129,
            "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentAmount": 0,
            "paymentChannelId": "123asdf",
            "paymentChannelName": "My Payment Channel",
            "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentMemo": "Payment memo",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "payorPaymentId": "123123asdf",
            "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "railsBatchId": "railsBatchId",
            "railsId": "asdf123",
            "railsPaymentId": "railsPaymentId",
            "rate": 6.0274563,
            "rejectionReason": "rejectionReason",
            "remoteId": "aasdf123",
            "returnCost": 1232,
            "returnReason": "Some Reason Value",
            "routingNumber": "123123123123",
            "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "sourceAccountName": "My Account",
            "sourceAmount": 12345,
            "status": "ACCEPTED",
            "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
            "traceNumber": "abodu123"
        },
        {
            "accountName": "My Account Name",
            "accountNumber": "123123232323",
            "countryCode": "US",
            "events": [
                {
                    "accountName": "My account",
                    "accountNumber": "123123123",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "DE89 3704 0044 0532 0130 00",
                    "paymentAmount": 1299,
                    "principal": "Prinicple example",
                    "routingNumber": "123123123",
                    "sourceAmount": 1299
                },
                {
                    "accountName": "My account",
                    "accountNumber": "123123123",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "DE89 3704 0044 0532 0130 00",
                    "paymentAmount": 1299,
                    "principal": "Prinicple example",
                    "routingNumber": "123123123",
                    "sourceAmount": 1299
                }
            ],
            "filenameReference": "file ref",
            "fundingStatus": "FUNDED",
            "iban": "DE89 3704 0044 0532 0130 00",
            "individualIdentificationNumber": "1231231adf",
            "invertedRate": 1.4658129,
            "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentAmount": 0,
            "paymentChannelId": "123asdf",
            "paymentChannelName": "My Payment Channel",
            "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentMemo": "Payment memo",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "payorPaymentId": "123123asdf",
            "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "railsBatchId": "railsBatchId",
            "railsId": "asdf123",
            "railsPaymentId": "railsPaymentId",
            "rate": 6.0274563,
            "rejectionReason": "rejectionReason",
            "remoteId": "aasdf123",
            "returnCost": 1232,
            "returnReason": "Some Reason Value",
            "routingNumber": "123123123123",
            "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "sourceAccountName": "My Account",
            "sourceAmount": 12345,
            "status": "ACCEPTED",
            "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
            "traceNumber": "abodu123"
        }
    ],
    "links": [
        {
            "href": "https://example.com",
            "rel": "first"
        },
        {
            "href": "https://example.com",
            "rel": "first"
        }
    ],
    "page": {
        "numberOfElements": 12,
        "page": 1,
        "pageSize": 25,
        "totalElements": 12,
        "totalPages": 10
    },
    "summary": {
        "confirmedPayments": 123,
        "failedPayments": 0,
        "incompletePayments": 123,
        "instructedDateTime": "2000-01-23T04:56:07.000+00:00",
        "payoutMemo": "Payment Memo value",
        "payoutStatus": "ACCEPTED",
        "releasedPayments": 123,
        "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
        "totalPayments": 123,
        "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00"
    }
}

Request

Path Params

Query Params

Responses

🟢200200 response, data found okay

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:18

V3 Get Payouts for Payor

V3 Export Transactions