# Velo Payments APIs API

> Velo Payments APIs API on Apizie: 73 endpoints (Authentication endpoint, Get Funding Audit Delta, Get Funding, Logout, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/ecommerce:velopayments/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:velopayments`
- Category: E-commerce
- Status: byok
- Source: https://velopayments.com
- Page: https://apizie.tech/api/ecommerce/velopayments
- OpenAPI: https://apizie.tech/api/ecommerce/velopayments/openapi.json

## Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. *…

## Endpoints

### Authentication endpoint
`POST https://apizie.tech/v1/ecommerce:velopayments/velo-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| grant_type | string | no | OAuth grant type. Should use 'client_credentials' |

### Get Funding Audit Delta
`GET https://apizie.tech/v1/ecommerce:velopayments/list-funding-audit-deltas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes |  |
| updatedSince | string | yes |  |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |

### Get Funding
`GET https://apizie.tech/v1/ecommerce:velopayments/get-funding-by-id-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fundingId | string | yes |  |

### Logout
`POST https://apizie.tech/v1/ecommerce:velopayments/logout` (byok)

### Reset password
`POST https://apizie.tech/v1/ecommerce:velopayments/reset-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Withdraw a Payment
`POST https://apizie.tech/v1/ecommerce:velopayments/withdraw-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentId | string | yes | Id of the Payment |
| body | object | yes | JSON request body |

### List Payor Links
`GET https://apizie.tech/v1/ecommerce:velopayments/payor-links-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| descendantsOfPayor | string | no | The Payor ID from which to start the query to show all descendants |
| parentOfPayor | string | no | Query for the parent payor details for this payor id |
| fields | string | no | List of additional Payor fields to include in the response for each Payor The values of payorId and payorName are always included for each… |

### Create a Payor Link
`POST https://apizie.tech/v1/ecommerce:velopayments/create-payor-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Create Application
`POST https://apizie.tech/v1/ecommerce:velopayments/payor-create-application-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor Id |
| body | object | yes | JSON request body |

### Create API Key
`POST https://apizie.tech/v1/ecommerce:velopayments/payor-create-api-key-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor Id |
| applicationId | string | yes | Application ID |
| body | object | yes | JSON request body |

### Get Branding
`GET https://apizie.tech/v1/ecommerce:velopayments/payor-get-branding` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor Id |

### Add Logo
`POST https://apizie.tech/v1/ecommerce:velopayments/payor-add-payor-logo-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor Id |
| body | object | yes | Form fields as a JSON object |

### Reminder Email Opt-Out
`POST https://apizie.tech/v1/ecommerce:velopayments/payor-email-opt-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor Id |
| body | object | yes | JSON request body |

### validate
`POST https://apizie.tech/v1/ecommerce:velopayments/validate-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List the details about the webhooks for the given payor.
`GET https://apizie.tech/v1/ecommerce:velopayments/list-webhooks-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| payorId | string | yes | The Payor ID |

### Create Webhook
`POST https://apizie.tech/v1/ecommerce:velopayments/create-webhook-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get details about the given webhook.
`GET https://apizie.tech/v1/ecommerce:velopayments/get-webhook-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Webhook id |

### Update Webhook
`POST https://apizie.tech/v1/ecommerce:velopayments/update-webhook-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Webhook id |
| body | object | no | JSON request body |

### POST /v1/webhooks/{webhookId}/ping
`POST https://apizie.tech/v1/ecommerce:velopayments/ping-webhook-v1` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Webhook id |

### List Supported Currencies
`GET https://apizie.tech/v1/ecommerce:velopayments/list-supported-currencies-v2` (byok)

### Get Funding Accounts
`GET https://apizie.tech/v1/ecommerce:velopayments/get-funding-accounts-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | no |  |
| name | string | no | The descriptive funding account name |
| country | string | no | The 2 letter ISO 3166-1 country code (upper case) |
| currency | string | no | The ISO 4217 currency code |
| type | string | no | The type of funding account. |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name. |
| sensitive | boolean | no |  |

### Create Funding Account
`POST https://apizie.tech/v1/ecommerce:velopayments/create-funding-account-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Funding Account
`GET https://apizie.tech/v1/ecommerce:velopayments/get-funding-account-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fundingAccountId | string | yes |  |
| sensitive | boolean | no |  |

### Get Payor
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payor-by-id-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor Id |

### List Users
`GET https://apizie.tech/v1/ecommerce:velopayments/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | no | The Type of the User. |
| status | string | no | The status of the User. |
| entityId | string | no | The entityId of the User. |
| payeeType | string | no | The Type of the Payee entity. Either COMPANY or INDIVIDUAL. |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae. |

### Invite a User
`POST https://apizie.tech/v1/ecommerce:velopayments/invite-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Register SMS Number
`POST https://apizie.tech/v1/ecommerce:velopayments/register-sms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get Self
`GET https://apizie.tech/v1/ecommerce:velopayments/get-self` (byok)

### Unregister MFA for Self
`POST https://apizie.tech/v1/ecommerce:velopayments/unregister-mfafor-self` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update Password for self
`POST https://apizie.tech/v1/ecommerce:velopayments/update-password-self` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Validate the proposed password
`POST https://apizie.tech/v1/ecommerce:velopayments/validate-password-self` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update User Details for self
`POST https://apizie.tech/v1/ecommerce:velopayments/user-details-update-for-self` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get User
`GET https://apizie.tech/v1/ecommerce:velopayments/get-user-by-id-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |

### Delete a User
`POST https://apizie.tech/v1/ecommerce:velopayments/delete-user-by-id-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |

### Disable a User
`POST https://apizie.tech/v1/ecommerce:velopayments/disable-user-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |

### Enable a User
`POST https://apizie.tech/v1/ecommerce:velopayments/enable-user-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |

### Unregister MFA for the user
`POST https://apizie.tech/v1/ecommerce:velopayments/unregister-mfa` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |
| body | object | yes | JSON request body |

### Update User Role
`POST https://apizie.tech/v1/ecommerce:velopayments/role-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |
| body | object | yes | JSON request body |

### Resend a token
`POST https://apizie.tech/v1/ecommerce:velopayments/resend-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |
| body | object | yes | JSON request body |

### Unlock a User
`POST https://apizie.tech/v1/ecommerce:velopayments/unlock-user-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |

### Update User Details
`POST https://apizie.tech/v1/ecommerce:velopayments/user-details-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | The UUID of the User. |
| body | object | yes | JSON request body |

### Submit Payout
`POST https://apizie.tech/v1/ecommerce:velopayments/submit-payout-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get Payout Summary
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payout-summary-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |

### Instruct Payout
`POST https://apizie.tech/v1/ecommerce:velopayments/instruct-payout-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |
| body | object | no | JSON request body |

### Withdraw Payout
`POST https://apizie.tech/v1/ecommerce:velopayments/withdraw-payout-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |

### Retrieve payments for a payout
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payments-for-payout-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |
| status | string | no | Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment… |
| remoteId | string | no | The remote id of the payees. |
| payorPaymentId | string | no | Payor's Id of the Payment |
| sourceAccountName | string | no | Physical Account Name |
| transmissionType | string | no | Transmission Type * ACH * SAME_DAY_ACH * WIRE |
| paymentMemo | string | no | Payment Memo of the Payment |
| pageSize | integer | no | The number of results to return in a page |
| page | integer | no | Page number. Default is 1. |

### Create a quote for the payout
`POST https://apizie.tech/v1/ecommerce:velopayments/create-quote-for-payout-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |

### Schedule a payout
`POST https://apizie.tech/v1/ecommerce:velopayments/schedule-for-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |
| body | object | no | JSON request body |

### Deschedule a payout
`POST https://apizie.tech/v1/ecommerce:velopayments/deschedule-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payoutId | string | yes | Id of the payout |

### Get list of source accounts
`GET https://apizie.tech/v1/ecommerce:velopayments/get-source-accounts-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| physicalAccountName | string | no | Physical Account Name |
| physicalAccountId | string | no | The physical account ID |
| payorId | string | no | The account owner Payor ID |
| fundingAccountId | string | no | The funding account ID |
| includeUserDeleted | string | no | A filter for retrieving both active accounts and user deleted ones |
| type | string | no | The type of source account. |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance |

### Get details about given source account.
`GET https://apizie.tech/v1/ecommerce:velopayments/get-source-account-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceAccountId | string | yes | Source account id |

### Delete a source account by ID
`POST https://apizie.tech/v1/ecommerce:velopayments/delete-source-account-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceAccountId | string | yes | Source account id |

### Create Funding Request
`POST https://apizie.tech/v1/ecommerce:velopayments/create-funding-request-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceAccountId | string | yes | Source account id |
| body | object | yes | JSON request body |

### Set notifications
`POST https://apizie.tech/v1/ecommerce:velopayments/set-notifications-request-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceAccountId | string | yes | Source account id |
| body | object | yes | JSON request body |

### Transfer Funds between source accounts
`POST https://apizie.tech/v1/ecommerce:velopayments/transfer-funds-v3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceAccountId | string | yes | The 'from' source account id, which will be debited |
| body | object | yes | JSON request body |

### List Payees
`GET https://apizie.tech/v1/ecommerce:velopayments/list-payees-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The account owner Payor ID |
| watchlistStatus | string | no | The watchlistStatus of the payees. |
| disabled | boolean | no | Payee disabled |
| onboardedStatus | string | no | The onboarded status of the payees. |
| email | string | no | Email address |
| displayName | string | no | The display name of the payees. |
| remoteId | string | no | The remote id of the payees. |
| payeeType | string | no | The onboarded status of the payees. |
| payeeCountry | string | no | The country of the payee - 2 letter ISO 3166-1 country code (upper case) |
| ofacStatus | string | no | The ofacStatus of the payees. |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | Page size. Default is 25. Max allowable is 100. |
| sort | string | no | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last… |

### Initiate Payee Creation
`POST https://apizie.tech/v1/ecommerce:velopayments/v4-create-payee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Query Batch Status
`GET https://apizie.tech/v1/ecommerce:velopayments/query-batch-status-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| batchId | string | yes | Batch Id |

### List Payee Changes
`GET https://apizie.tech/v1/ecommerce:velopayments/list-payee-changes-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor ID to find associated Payees |
| updatedSince | string | yes | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | Page size. Default is 100. Max allowable is 1000. |

### Get Payee Invitation Status
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payees-invitation-status-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The account owner Payor ID |
| payeeId | string | no | The UUID of the payee. |
| invitationStatus | string | no | The invitation status of the payees. |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | Page size. Default is 25. Max allowable is 100. |

### Get Payee by Id
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payee-by-id-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payeeId | string | yes | The UUID of the payee. |
| sensitive | boolean | no | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have… |

### Delete Payee by Id
`POST https://apizie.tech/v1/ecommerce:velopayments/delete-payee-by-id-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payeeId | string | yes | The UUID of the payee. |

### Resend Payee Invite
`POST https://apizie.tech/v1/ecommerce:velopayments/resend-payee-invite-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payeeId | string | yes | The UUID of the payee. |
| body | object | yes | JSON request body |

### Update Payee Details
`POST https://apizie.tech/v1/ecommerce:velopayments/payee-details-update-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payeeId | string | yes | The UUID of the payee. |
| body | object | yes | JSON request body |

### Update Payee Remote Id
`POST https://apizie.tech/v1/ecommerce:velopayments/post-v4-payees-payee-id-remote-id-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payeeId | string | yes | The UUID of the payee. |
| body | object | yes | JSON request body |

### Get Fundings for Payor
`GET https://apizie.tech/v1/ecommerce:velopayments/get-fundings-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The account owner Payor ID |
| sourceAccountName | string | no | The source account name |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are:… |

### Get List of Payments
`GET https://apizie.tech/v1/ecommerce:velopayments/list-payments-audit-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payeeId | string | no | The UUID of the payee. |
| payorId | string | no | The account owner Payor Id. Required for external users. |
| payorName | string | no | The payor’s name. This filters via a case insensitive substring match. |
| remoteId | string | no | The remote id of the payees. |
| remoteSystemId | string | no | The id of the remote system that is orchestrating payments |
| status | string | no | Payment Status |
| transmissionType | string | no | Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO |
| sourceAccountName | string | no | The source account name filter. This filters via a case insensitive substring match. |
| sourceAmountFrom | integer | no | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom |
| sourceAmountTo | integer | no | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo |
| sourceCurrency | string | no | The source currency filter. Filters based on an exact match on the currency. |
| paymentAmountFrom | integer | no | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom |
| paymentAmountTo | integer | no | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo |
| paymentCurrency | string | no | The payment currency filter. Filters based on an exact match on the currency. |
| submittedDateFrom | string | no | The submitted date from range filter. Format is yyyy-MM-dd. |
| submittedDateTo | string | no | The submitted date to range filter. Format is yyyy-MM-dd. |
| paymentMemo | string | no | The payment memo filter. This filters via a case insensitive substring match. |
| railsId | string | no | Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this… |
| scheduledForDateFrom | string | no | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. |
| scheduledForDateTo | string | no | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. |
| scheduleStatus | string | no | Payout Schedule Status |
| postInstructFxStatus | string | no | The status of the post instruct FX step if one was required for the payment |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported… |
| sensitive | boolean | no | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have… |

### Get Payment
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payment-details-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentId | string | yes | Payment Id |
| sensitive | boolean | no | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have… |

### Get Payout Statistics
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payout-stats-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | no | The account owner Payor ID. Required for external users. |

### Get Payouts for Payor
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payouts-for-payor-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | no | The id (UUID) of the payor funding the payout or the payor whose payees are being paid. |
| payoutMemo | string | no | Payout Memo filter - case insensitive sub-string match |
| status | string | no | Payout Status |
| submittedDateFrom | string | no | The submitted date from range filter. Format is yyyy-MM-dd. |
| submittedDateTo | string | no | The submitted date to range filter. Format is yyyy-MM-dd. |
| fromPayorName | string | no | The name of the payor whose payees are being paid. This filters via a case insensitive substring match. |
| scheduledForDateFrom | string | no | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. |
| scheduledForDateTo | string | no | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. |
| scheduleStatus | string | no | Payout Schedule Status |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported… |

### Get Payments for Payout
`GET https://apizie.tech/v1/ecommerce:velopayments/get-payments-for-payout-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| railsId | string | no | Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this… |
| payoutId | string | yes | The id (UUID) of the payout. |
| remoteId | string | no | The remote id of the payees. |
| remoteSystemId | string | no | The id of the remote system that is orchestrating payments |
| status | string | no | Payment Status |
| sourceAmountFrom | integer | no | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom |
| sourceAmountTo | integer | no | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo |
| paymentAmountFrom | integer | no | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom |
| paymentAmountTo | integer | no | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo |
| submittedDateFrom | string | no | The submitted date from range filter. Format is yyyy-MM-dd. |
| submittedDateTo | string | no | The submitted date to range filter. Format is yyyy-MM-dd. |
| transmissionType | string | no | Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |
| sort | string | no | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are:… |
| sensitive | boolean | no | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have… |

### Export Transactions
`GET https://apizie.tech/v1/ecommerce:velopayments/export-transactions-csvv4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | no | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a… |
| startDate | string | no | Start date, inclusive. Format is YYYY-MM-DD |
| endDate | string | no | End date, inclusive. Format is YYYY-MM-DD |
| include | string | no | Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to… |

### List Payment Changes
`GET https://apizie.tech/v1/ecommerce:velopayments/list-payment-changes-v4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payorId | string | yes | The Payor ID to find associated Payments |
| updatedSince | string | yes | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm |
| page | integer | no | Page number. Default is 1. |
| pageSize | integer | no | The number of results to return in a page |

## Example
```
curl "https://apizie.tech/v1/ecommerce:velopayments/velo-auth" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Velo Payments APIs API?
Create a free Apizie key, then send POST https://apizie.tech/v1/ecommerce:velopayments/velo-auth with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Velo Payments APIs API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Velo Payments APIs itself also needs your own key from velopayments.com.

### Can AI agents use the Velo Payments APIs API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:velopayments.

### What is the status of the Velo Payments APIs API?
Needs your own provider key (bring your own key)