Velo Payments APIs
  1. Payment Audit Service
Velo Payments APIs
  • Login
    • Authentication endpoint
      POST
    • Logout
      POST
    • Reset password
      POST
    • validate
      POST
  • Funding Manager
    • Get Funding Audit Delta
      GET
    • Get Funding Accounts
      GET
    • Get Funding Account
      GET
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Set notifications
      POST
    • Get Funding Accounts
      GET
    • Get Funding Account
      GET
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Transfer Funds between source accounts
      POST
    • Get list of source accounts
      GET
    • Get details about given source account.
      GET
    • Create Funding Request
      POST
    • Transfer Funds between source accounts
      POST
  • Payment Audit Service (Deprecated)
    • V1 List Payment Changes
    • V1 Get Fundings for Payor
    • V1 Get Payout Statistics
    • V3 Get List of Payments
    • V3 Get Payment
    • V3 Get Payouts for Payor
    • V3 Get Payments for Payout
    • V3 Export Transactions
  • Countries
    • List Payment Channel Country Rules
    • List Supported Countries
    • List Supported Countries
  • Payout Service
    • Withdraw a Payment
    • Submit Payout
    • Withdraw Payout
    • Get Payout Summary
    • Instruct Payout
    • Retrieve payments for a payout
    • Create a quote for the payout
  • Payors
    • List Payor Links
    • Get Payor
    • Create Application
    • Create API Key
    • Get Branding
    • Add Logo
    • Reminder Email Opt-Out
    • Get Payor
  • Payors Private
    • Create a Payor Link
  • Webhooks
    • List the details about the webhooks for the given payor.
    • Create Webhook
    • Get details about the given webhook.
    • Update Webhook
    • /v1/webhooks/{webhookId}/ping
  • Currencies
    • List Supported Currencies
  • Funding Manager Private
    • Create Funding Account
    • Delete a source account by ID
  • Users
    • List Users
    • Invite a User
    • Register SMS Number
    • Get Self
    • Unregister MFA for Self
    • Update Password for self
    • Validate the proposed password
    • Update User Details for self
    • Delete a User
    • Get User
    • Disable a User
    • Enable a User
    • Unregister MFA for the user
    • Update User Role
    • Unlock a User
    • Update User Details
  • Tokens
    • Resend a token
  • Payees
    • List Payees
    • List Payee Changes
    • Delete Payee by Id
    • Get Payee by Id
    • Update Payee Details
    • Update Payee Remote Id
    • List Payees
    • List Payee Changes
    • Delete Payee by Id
    • Get Payee by Id
    • Update Payee Details
    • Update Payee Remote Id
  • Payee Invitation
    • Initiate Payee Creation
    • Query Batch Status
    • Get Payee Invitation Status
    • Resend Payee Invite
    • Initiate Payee Creation
    • Query Batch Status
    • Get Payee Invitation Status
    • Resend Payee Invite
  • Payment Audit Service
    • Get Fundings for Payor
      GET
    • Get List of Payments
      GET
    • Get Payment
      GET
    • Get Payout Statistics
      GET
    • Get Payouts for Payor
      GET
    • Get Payments for Payout
      GET
    • Export Transactions
      GET
    • List Payment Changes
      GET
  1. Payment Audit Service

Get Payments for Payout

Velo Payments Sandbox for testing
https://api.sandbox.velopayments.com/
Velo Payments Sandbox for testing
https://api.sandbox.velopayments.com/
GET
/v4/paymentaudit/payouts/{payoutId}
Get List of payments for Payout, allowing for RETURNED status
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.sandbox.velopayments.com//v4/paymentaudit/payouts/'
Response Response Example
200 - Example 1
{
    "content": [
        {
            "accountName": "My Account Name",
            "accountNumber": "123123232323",
            "countryCode": "US",
            "events": [
                {
                    "accountName": "accountName",
                    "accountNumber": "accountNumber",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "iban",
                    "paymentAmount": 1299,
                    "principal": "principal",
                    "routingNumber": "routingNumber",
                    "sourceAmount": 1299
                },
                {
                    "accountName": "accountName",
                    "accountNumber": "accountNumber",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "iban",
                    "paymentAmount": 1299,
                    "principal": "principal",
                    "routingNumber": "routingNumber",
                    "sourceAmount": 1299
                }
            ],
            "filenameReference": "file ref",
            "fundingStatus": "FUNDED",
            "iban": "DE89 3704 0044 0532 0130 00",
            "individualIdentificationNumber": "1231231adf",
            "invertedRate": 3.616076749251911,
            "isPaymentCcyBaseCcy": true,
            "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentAmount": 7,
            "paymentChannelId": "123asdf",
            "paymentChannelName": "My Payment Channel",
            "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentMemo": "Payment memo",
            "paymentMetadata": "sample metadata",
            "paymentTrackingReference": "paymentTrackingReference",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "payorPaymentId": "123123asdf",
            "payout": {
                "payoutFrom": {
                    "dbaName": "dbaName",
                    "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "payorName": "payorName",
                    "principal": "principal",
                    "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
                },
                "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                "payoutTo": {
                    "dbaName": "dbaName",
                    "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "payorName": "payorName",
                    "principal": "principal",
                    "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
                }
            },
            "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "railsBatchId": "railsBatchId",
            "railsId": "asdf123",
            "railsPaymentId": "railsPaymentId",
            "rate": 9.301444243932576,
            "rejectionReason": "rejectionReason",
            "remoteId": "aasdf123",
            "remoteSystemId": "REMOTE_SYSTEM_ID",
            "remoteSystemPaymentId": "remoteSystemPaymentId",
            "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",
            "transmissionType": "transmissionType",
            "withdrawable": true,
            "withdrawnReason": "withdrawnReason"
        },
        {
            "accountName": "My Account Name",
            "accountNumber": "123123232323",
            "countryCode": "US",
            "events": [
                {
                    "accountName": "accountName",
                    "accountNumber": "accountNumber",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "iban",
                    "paymentAmount": 1299,
                    "principal": "principal",
                    "routingNumber": "routingNumber",
                    "sourceAmount": 1299
                },
                {
                    "accountName": "accountName",
                    "accountNumber": "accountNumber",
                    "eventDateTime": "2000-01-23T04:56:07.000+00:00",
                    "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "eventType": "PAYOUT_SUBMITTED",
                    "iban": "iban",
                    "paymentAmount": 1299,
                    "principal": "principal",
                    "routingNumber": "routingNumber",
                    "sourceAmount": 1299
                }
            ],
            "filenameReference": "file ref",
            "fundingStatus": "FUNDED",
            "iban": "DE89 3704 0044 0532 0130 00",
            "individualIdentificationNumber": "1231231adf",
            "invertedRate": 3.616076749251911,
            "isPaymentCcyBaseCcy": true,
            "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentAmount": 7,
            "paymentChannelId": "123asdf",
            "paymentChannelName": "My Payment Channel",
            "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "paymentMemo": "Payment memo",
            "paymentMetadata": "sample metadata",
            "paymentTrackingReference": "paymentTrackingReference",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "payorPaymentId": "123123asdf",
            "payout": {
                "payoutFrom": {
                    "dbaName": "dbaName",
                    "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "payorName": "payorName",
                    "principal": "principal",
                    "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
                },
                "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                "payoutTo": {
                    "dbaName": "dbaName",
                    "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
                    "payorName": "payorName",
                    "principal": "principal",
                    "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
                }
            },
            "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "railsBatchId": "railsBatchId",
            "railsId": "asdf123",
            "railsPaymentId": "railsPaymentId",
            "rate": 9.301444243932576,
            "rejectionReason": "rejectionReason",
            "remoteId": "aasdf123",
            "remoteSystemId": "REMOTE_SYSTEM_ID",
            "remoteSystemPaymentId": "remoteSystemPaymentId",
            "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",
            "transmissionType": "transmissionType",
            "withdrawable": true,
            "withdrawnReason": "withdrawnReason"
        }
    ],
    "links": [
        {
            "href": "href",
            "rel": "rel"
        },
        {
            "href": "href",
            "rel": "rel"
        }
    ],
    "page": {
        "numberOfElements": 0,
        "page": 5,
        "pageSize": 5,
        "totalElements": 6,
        "totalPages": 1
    },
    "summary": {
        "confirmedPayments": 6,
        "incompletePayments": 5,
        "instructed": {
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "instructedDateTime": "2000-01-23T04:56:07.000+00:00",
        "payoutFrom": {
            "dbaName": "dbaName",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "payoutMemo": "payoutMemo",
        "payoutTo": {
            "dbaName": "dbaName",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "quoted": {
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "quotedDateTime": "2000-01-23T04:56:07.000+00:00",
        "releasedPayments": 1,
        "returnedPayments": 5,
        "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
        "submitting": {
            "dbaName": "dbaName",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "totalPayments": 0,
        "withdrawn": {
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "withdrawnDateTime": "2000-01-23T04:56:07.000+00:00",
        "withdrawnPayments": 2
    }
}

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:19
Previous
Get Payouts for Payor
Next
Export Transactions
Built with