{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:velopayments/velo-auth":{"post":{"operationId":"ecommerce_velopayments_velo_auth","summary":"Authentication endpoint","description":"POST /v1/authenticate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"grant_type":{"type":"string","default":"client_credentials","description":"OAuth grant type. Should use 'client_credentials'"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-funding-audit-deltas":{"get":{"operationId":"ecommerce_velopayments_list_funding_audit_deltas","summary":"Get Funding Audit Delta","description":"GET /v1/deltas/fundings","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-funding-by-id-v1":{"get":{"operationId":"ecommerce_velopayments_get_funding_by_id_v1","summary":"Get Funding","description":"GET /v1/fundings/{fundingId}","tags":["ecommerce"],"parameters":[{"name":"fundingId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/logout":{"post":{"operationId":"ecommerce_velopayments_logout","summary":"Logout","description":"POST /v1/logout","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/reset-password":{"post":{"operationId":"ecommerce_velopayments_reset_password","summary":"Reset password","description":"POST /v1/password/reset","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/withdraw-payment":{"post":{"operationId":"ecommerce_velopayments_withdraw_payment","summary":"Withdraw a Payment","description":"POST /v1/payments/{paymentId}/withdraw","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"paymentId":{"type":"string","description":"Id of the Payment"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payor-links-v1":{"get":{"operationId":"ecommerce_velopayments_payor_links_v1","summary":"List Payor Links","description":"GET /v1/payorLinks","tags":["ecommerce"],"parameters":[{"name":"descendantsOfPayor","in":"query","required":false,"description":"The Payor ID from which to start the query to show all descendants","schema":{"type":"string","description":"The Payor ID from which to start the query to show all descendants"}},{"name":"parentOfPayor","in":"query","required":false,"description":"Query for the parent payor details for this payor id","schema":{"type":"string","description":"Query for the parent payor details for this payor id"}},{"name":"fields","in":"query","required":false,"description":"List of additional Payor fields to include in the response for each Payor The values of payorId and payorName are always included for each…","schema":{"type":"string","description":"List of additional Payor fields to include in the response for each Payor The values of payorId and payorName are always included for each…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/create-payor-links":{"post":{"operationId":"ecommerce_velopayments_create_payor_links","summary":"Create a Payor Link","description":"POST /v1/payorLinks","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payor-create-application-v1":{"post":{"operationId":"ecommerce_velopayments_payor_create_application_v1","summary":"Create Application","description":"POST /v1/payors/{payorId}/applications","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payorId","body"],"properties":{"payorId":{"type":"string","description":"The Payor Id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payor-create-api-key-v1":{"post":{"operationId":"ecommerce_velopayments_payor_create_api_key_v1","summary":"Create API Key","description":"POST /v1/payors/{payorId}/applications/{applicationId}/keys","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payorId","applicationId","body"],"properties":{"payorId":{"type":"string","description":"The Payor Id"},"applicationId":{"type":"string","description":"Application ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payor-get-branding":{"get":{"operationId":"ecommerce_velopayments_payor_get_branding","summary":"Get Branding","description":"GET /v1/payors/{payorId}/branding","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The Payor Id","schema":{"type":"string","description":"The Payor Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payor-add-payor-logo-v1":{"post":{"operationId":"ecommerce_velopayments_payor_add_payor_logo_v1","summary":"Add Logo","description":"POST /v1/payors/{payorId}/branding/logos","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payorId","body"],"properties":{"payorId":{"type":"string","description":"The Payor Id"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payor-email-opt-out":{"post":{"operationId":"ecommerce_velopayments_payor_email_opt_out","summary":"Reminder Email Opt-Out","description":"POST /v1/payors/{payorId}/reminderEmailsUpdate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payorId","body"],"properties":{"payorId":{"type":"string","description":"The Payor Id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/validate-access-token":{"post":{"operationId":"ecommerce_velopayments_validate_access_token","summary":"validate","description":"POST /v1/validate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-webhooks-v1":{"get":{"operationId":"ecommerce_velopayments_list_webhooks_v1","summary":"List the details about the webhooks for the given payor.","description":"GET /v1/webhooks","tags":["ecommerce"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"payorId","in":"query","required":true,"description":"The Payor ID","schema":{"type":"string","description":"The Payor ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/create-webhook-v1":{"post":{"operationId":"ecommerce_velopayments_create_webhook_v1","summary":"Create Webhook","description":"POST /v1/webhooks","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-webhook-v1":{"get":{"operationId":"ecommerce_velopayments_get_webhook_v1","summary":"Get details about the given webhook.","description":"GET /v1/webhooks/{webhookId}","tags":["ecommerce"],"parameters":[{"name":"webhookId","in":"query","required":true,"description":"Webhook id","schema":{"type":"string","description":"Webhook id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/update-webhook-v1":{"post":{"operationId":"ecommerce_velopayments_update_webhook_v1","summary":"Update Webhook","description":"POST /v1/webhooks/{webhookId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId"],"properties":{"webhookId":{"type":"string","description":"Webhook id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/ping-webhook-v1":{"post":{"operationId":"ecommerce_velopayments_ping_webhook_v1","summary":"POST /v1/webhooks/{webhookId}/ping","description":"POST /v1/webhooks/{webhookId}/ping","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId"],"properties":{"webhookId":{"type":"string","description":"Webhook id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-supported-currencies-v2":{"get":{"operationId":"ecommerce_velopayments_list_supported_currencies_v2","summary":"List Supported Currencies","description":"GET /v2/currencies","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-funding-accounts-v2":{"get":{"operationId":"ecommerce_velopayments_get_funding_accounts_v2","summary":"Get Funding Accounts","description":"GET /v2/fundingAccounts","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"description":"The descriptive funding account name","schema":{"type":"string","description":"The descriptive funding account name"}},{"name":"country","in":"query","required":false,"description":"The 2 letter ISO 3166-1 country code (upper case)","schema":{"type":"string","description":"The 2 letter ISO 3166-1 country code (upper case)"}},{"name":"currency","in":"query","required":false,"description":"The ISO 4217 currency code","schema":{"type":"string","description":"The ISO 4217 currency code"}},{"name":"type","in":"query","required":false,"description":"The type of funding account.","schema":{"type":"string","description":"The type of funding account."}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name.","schema":{"type":"string","default":"accountName:asc","description":"List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name."}},{"name":"sensitive","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/create-funding-account-v2":{"post":{"operationId":"ecommerce_velopayments_create_funding_account_v2","summary":"Create Funding Account","description":"POST /v2/fundingAccounts","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-funding-account-v2":{"get":{"operationId":"ecommerce_velopayments_get_funding_account_v2","summary":"Get Funding Account","description":"GET /v2/fundingAccounts/{fundingAccountId}","tags":["ecommerce"],"parameters":[{"name":"fundingAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"sensitive","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payor-by-id-v2":{"get":{"operationId":"ecommerce_velopayments_get_payor_by_id_v2","summary":"Get Payor","description":"GET /v2/payors/{payorId}","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The Payor Id","schema":{"type":"string","description":"The Payor Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-users":{"get":{"operationId":"ecommerce_velopayments_list_users","summary":"List Users","description":"GET /v2/users","tags":["ecommerce"],"parameters":[{"name":"type","in":"query","required":false,"description":"The Type of the User.","schema":{"type":"string","enum":["BACKOFFICE","PAYOR","PAYEE"],"description":"The Type of the User."}},{"name":"status","in":"query","required":false,"description":"The status of the User.","schema":{"type":"string","enum":["ENABLED","DISABLED","PENDING"],"description":"The status of the User."}},{"name":"entityId","in":"query","required":false,"description":"The entityId of the User.","schema":{"type":"string","description":"The entityId of the User."}},{"name":"payeeType","in":"query","required":false,"description":"The Type of the Payee entity. Either COMPANY or INDIVIDUAL.","schema":{"type":"string","enum":["COMPANY","INDIVIDUAL"],"description":"The Type of the Payee entity. Either COMPANY or INDIVIDUAL."}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae.","schema":{"type":"string","default":"email:asc","description":"List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/invite-user":{"post":{"operationId":"ecommerce_velopayments_invite_user","summary":"Invite a User","description":"POST /v2/users/invite","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/register-sms":{"post":{"operationId":"ecommerce_velopayments_register_sms","summary":"Register SMS Number","description":"POST /v2/users/registration/sms","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-self":{"get":{"operationId":"ecommerce_velopayments_get_self","summary":"Get Self","description":"GET /v2/users/self","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/unregister-mfafor-self":{"post":{"operationId":"ecommerce_velopayments_unregister_mfafor_self","summary":"Unregister MFA for Self","description":"POST /v2/users/self/mfa/unregister","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/update-password-self":{"post":{"operationId":"ecommerce_velopayments_update_password_self","summary":"Update Password for self","description":"POST /v2/users/self/password","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/validate-password-self":{"post":{"operationId":"ecommerce_velopayments_validate_password_self","summary":"Validate the proposed password","description":"POST /v2/users/self/password/validate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/user-details-update-for-self":{"post":{"operationId":"ecommerce_velopayments_user_details_update_for_self","summary":"Update User Details for self","description":"POST /v2/users/self/userDetailsUpdate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-user-by-id-v2":{"get":{"operationId":"ecommerce_velopayments_get_user_by_id_v2","summary":"Get User","description":"GET /v2/users/{userId}","tags":["ecommerce"],"parameters":[{"name":"userId","in":"query","required":true,"description":"The UUID of the User.","schema":{"type":"string","description":"The UUID of the User."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/delete-user-by-id-v2":{"post":{"operationId":"ecommerce_velopayments_delete_user_by_id_v2","summary":"Delete a User","description":"DELETE /v2/users/{userId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The UUID of the User."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/disable-user-v2":{"post":{"operationId":"ecommerce_velopayments_disable_user_v2","summary":"Disable a User","description":"POST /v2/users/{userId}/disable","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The UUID of the User."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/enable-user-v2":{"post":{"operationId":"ecommerce_velopayments_enable_user_v2","summary":"Enable a User","description":"POST /v2/users/{userId}/enable","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The UUID of the User."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/unregister-mfa":{"post":{"operationId":"ecommerce_velopayments_unregister_mfa","summary":"Unregister MFA for the user","description":"POST /v2/users/{userId}/mfa/unregister","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","body"],"properties":{"userId":{"type":"string","description":"The UUID of the User."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/role-update":{"post":{"operationId":"ecommerce_velopayments_role_update","summary":"Update User Role","description":"POST /v2/users/{userId}/roleUpdate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","body"],"properties":{"userId":{"type":"string","description":"The UUID of the User."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/resend-token":{"post":{"operationId":"ecommerce_velopayments_resend_token","summary":"Resend a token","description":"POST /v2/users/{userId}/tokens","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","body"],"properties":{"userId":{"type":"string","description":"The UUID of the User."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/unlock-user-v2":{"post":{"operationId":"ecommerce_velopayments_unlock_user_v2","summary":"Unlock a User","description":"POST /v2/users/{userId}/unlock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The UUID of the User."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/user-details-update":{"post":{"operationId":"ecommerce_velopayments_user_details_update","summary":"Update User Details","description":"POST /v2/users/{userId}/userDetailsUpdate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","body"],"properties":{"userId":{"type":"string","description":"The UUID of the User."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/submit-payout-v3":{"post":{"operationId":"ecommerce_velopayments_submit_payout_v3","summary":"Submit Payout","description":"POST /v3/payouts","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payout-summary-v3":{"get":{"operationId":"ecommerce_velopayments_get_payout_summary_v3","summary":"Get Payout Summary","description":"GET /v3/payouts/{payoutId}","tags":["ecommerce"],"parameters":[{"name":"payoutId","in":"query","required":true,"description":"Id of the payout","schema":{"type":"string","description":"Id of the payout"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/instruct-payout-v3":{"post":{"operationId":"ecommerce_velopayments_instruct_payout_v3","summary":"Instruct Payout","description":"POST /v3/payouts/{payoutId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payoutId"],"properties":{"payoutId":{"type":"string","description":"Id of the payout"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/withdraw-payout-v3":{"post":{"operationId":"ecommerce_velopayments_withdraw_payout_v3","summary":"Withdraw Payout","description":"DELETE /v3/payouts/{payoutId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payoutId"],"properties":{"payoutId":{"type":"string","description":"Id of the payout"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payments-for-payout-v3":{"get":{"operationId":"ecommerce_velopayments_get_payments_for_payout_v3","summary":"Retrieve payments for a payout","description":"GET /v3/payouts/{payoutId}/payments","tags":["ecommerce"],"parameters":[{"name":"payoutId","in":"query","required":true,"description":"Id of the payout","schema":{"type":"string","description":"Id of the payout"}},{"name":"status","in":"query","required":false,"description":"Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment…","schema":{"type":"string","enum":["ACCEPTED","REJECTED","WITHDRAWN","WITHDRAWABLE"],"description":"Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment…"}},{"name":"remoteId","in":"query","required":false,"description":"The remote id of the payees.","schema":{"type":"string","description":"The remote id of the payees."}},{"name":"payorPaymentId","in":"query","required":false,"description":"Payor's Id of the Payment","schema":{"type":"string","description":"Payor's Id of the Payment"}},{"name":"sourceAccountName","in":"query","required":false,"description":"Physical Account Name","schema":{"type":"string","description":"Physical Account Name"}},{"name":"transmissionType","in":"query","required":false,"description":"Transmission Type * ACH * SAME_DAY_ACH * WIRE","schema":{"type":"string","enum":["ACH","SAME_DAY_ACH","WIRE"],"description":"Transmission Type * ACH * SAME_DAY_ACH * WIRE"}},{"name":"paymentMemo","in":"query","required":false,"description":"Payment Memo of the Payment","schema":{"type":"string","description":"Payment Memo of the Payment"}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/create-quote-for-payout-v3":{"post":{"operationId":"ecommerce_velopayments_create_quote_for_payout_v3","summary":"Create a quote for the payout","description":"POST /v3/payouts/{payoutId}/quote","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payoutId"],"properties":{"payoutId":{"type":"string","description":"Id of the payout"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/schedule-for-payout":{"post":{"operationId":"ecommerce_velopayments_schedule_for_payout","summary":"Schedule a payout","description":"POST /v3/payouts/{payoutId}/schedule","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payoutId"],"properties":{"payoutId":{"type":"string","description":"Id of the payout"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/deschedule-payout":{"post":{"operationId":"ecommerce_velopayments_deschedule_payout","summary":"Deschedule a payout","description":"DELETE /v3/payouts/{payoutId}/schedule","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payoutId"],"properties":{"payoutId":{"type":"string","description":"Id of the payout"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-source-accounts-v3":{"get":{"operationId":"ecommerce_velopayments_get_source_accounts_v3","summary":"Get list of source accounts","description":"GET /v3/sourceAccounts","tags":["ecommerce"],"parameters":[{"name":"physicalAccountName","in":"query","required":false,"description":"Physical Account Name","schema":{"type":"string","description":"Physical Account Name"}},{"name":"physicalAccountId","in":"query","required":false,"description":"The physical account ID","schema":{"type":"string","description":"The physical account ID"}},{"name":"payorId","in":"query","required":false,"description":"The account owner Payor ID","schema":{"type":"string","description":"The account owner Payor ID"}},{"name":"fundingAccountId","in":"query","required":false,"description":"The funding account ID","schema":{"type":"string","description":"The funding account ID"}},{"name":"includeUserDeleted","in":"query","required":false,"description":"A filter for retrieving both active accounts and user deleted ones","schema":{"type":"string","description":"A filter for retrieving both active accounts and user deleted ones"}},{"name":"type","in":"query","required":false,"description":"The type of source account.","schema":{"type":"string","description":"The type of source account."}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance","schema":{"type":"string","default":"fundingRef:asc","description":"List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-source-account-v3":{"get":{"operationId":"ecommerce_velopayments_get_source_account_v3","summary":"Get details about given source account.","description":"GET /v3/sourceAccounts/{sourceAccountId}","tags":["ecommerce"],"parameters":[{"name":"sourceAccountId","in":"query","required":true,"description":"Source account id","schema":{"type":"string","description":"Source account id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/delete-source-account-v3":{"post":{"operationId":"ecommerce_velopayments_delete_source_account_v3","summary":"Delete a source account by ID","description":"DELETE /v3/sourceAccounts/{sourceAccountId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceAccountId"],"properties":{"sourceAccountId":{"type":"string","description":"Source account id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/create-funding-request-v3":{"post":{"operationId":"ecommerce_velopayments_create_funding_request_v3","summary":"Create Funding Request","description":"POST /v3/sourceAccounts/{sourceAccountId}/fundingRequest","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceAccountId","body"],"properties":{"sourceAccountId":{"type":"string","description":"Source account id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/set-notifications-request-v3":{"post":{"operationId":"ecommerce_velopayments_set_notifications_request_v3","summary":"Set notifications","description":"POST /v3/sourceAccounts/{sourceAccountId}/notifications","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceAccountId","body"],"properties":{"sourceAccountId":{"type":"string","description":"Source account id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/transfer-funds-v3":{"post":{"operationId":"ecommerce_velopayments_transfer_funds_v3","summary":"Transfer Funds between source accounts","description":"POST /v3/sourceAccounts/{sourceAccountId}/transfers","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceAccountId","body"],"properties":{"sourceAccountId":{"type":"string","description":"The 'from' source account id, which will be debited"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-payees-v4":{"get":{"operationId":"ecommerce_velopayments_list_payees_v4","summary":"List Payees","description":"GET /v4/payees","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The account owner Payor ID","schema":{"type":"string","description":"The account owner Payor ID"}},{"name":"watchlistStatus","in":"query","required":false,"description":"The watchlistStatus of the payees.","schema":{"type":"string","description":"The watchlistStatus of the payees."}},{"name":"disabled","in":"query","required":false,"description":"Payee disabled","schema":{"type":"boolean","description":"Payee disabled"}},{"name":"onboardedStatus","in":"query","required":false,"description":"The onboarded status of the payees.","schema":{"type":"string","description":"The onboarded status of the payees."}},{"name":"email","in":"query","required":false,"description":"Email address","schema":{"type":"string","description":"Email address"}},{"name":"displayName","in":"query","required":false,"description":"The display name of the payees.","schema":{"type":"string","description":"The display name of the payees."}},{"name":"remoteId","in":"query","required":false,"description":"The remote id of the payees.","schema":{"type":"string","description":"The remote id of the payees."}},{"name":"payeeType","in":"query","required":false,"description":"The onboarded status of the payees.","schema":{"type":"string","description":"The onboarded status of the payees."}},{"name":"payeeCountry","in":"query","required":false,"description":"The country of the payee - 2 letter ISO 3166-1 country code (upper case)","schema":{"type":"string","description":"The country of the payee - 2 letter ISO 3166-1 country code (upper case)"}},{"name":"ofacStatus","in":"query","required":false,"description":"The ofacStatus of the payees.","schema":{"type":"string","description":"The ofacStatus of the payees."}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"Page size. Default is 25. Max allowable is 100.","schema":{"type":"integer","default":25,"description":"Page size. Default is 25. Max allowable is 100."}},{"name":"sort","in":"query","required":false,"description":"List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last…","schema":{"type":"string","default":"displayName:asc","description":"List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/v4-create-payee":{"post":{"operationId":"ecommerce_velopayments_v4_create_payee","summary":"Initiate Payee Creation","description":"POST /v4/payees","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/query-batch-status-v4":{"get":{"operationId":"ecommerce_velopayments_query_batch_status_v4","summary":"Query Batch Status","description":"GET /v4/payees/batch/{batchId}","tags":["ecommerce"],"parameters":[{"name":"batchId","in":"query","required":true,"description":"Batch Id","schema":{"type":"string","description":"Batch Id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-payee-changes-v4":{"get":{"operationId":"ecommerce_velopayments_list_payee_changes_v4","summary":"List Payee Changes","description":"GET /v4/payees/deltas","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The Payor ID to find associated Payees","schema":{"type":"string","description":"The Payor ID to find associated Payees"}},{"name":"updatedSince","in":"query","required":true,"description":"The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm","schema":{"type":"string","description":"The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"Page size. Default is 100. Max allowable is 1000.","schema":{"type":"integer","default":100,"description":"Page size. Default is 100. Max allowable is 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payees-invitation-status-v4":{"get":{"operationId":"ecommerce_velopayments_get_payees_invitation_status_v4","summary":"Get Payee Invitation Status","description":"GET /v4/payees/payors/{payorId}/invitationStatus","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The account owner Payor ID","schema":{"type":"string","description":"The account owner Payor ID"}},{"name":"payeeId","in":"query","required":false,"description":"The UUID of the payee.","schema":{"type":"string","description":"The UUID of the payee."}},{"name":"invitationStatus","in":"query","required":false,"description":"The invitation status of the payees.","schema":{"type":"string","description":"The invitation status of the payees."}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"Page size. Default is 25. Max allowable is 100.","schema":{"type":"integer","default":25,"description":"Page size. Default is 25. Max allowable is 100."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payee-by-id-v4":{"get":{"operationId":"ecommerce_velopayments_get_payee_by_id_v4","summary":"Get Payee by Id","description":"GET /v4/payees/{payeeId}","tags":["ecommerce"],"parameters":[{"name":"payeeId","in":"query","required":true,"description":"The UUID of the payee.","schema":{"type":"string","description":"The UUID of the payee."}},{"name":"sensitive","in":"query","required":false,"description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…","schema":{"type":"boolean","description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/delete-payee-by-id-v4":{"post":{"operationId":"ecommerce_velopayments_delete_payee_by_id_v4","summary":"Delete Payee by Id","description":"DELETE /v4/payees/{payeeId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payeeId"],"properties":{"payeeId":{"type":"string","description":"The UUID of the payee."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/resend-payee-invite-v4":{"post":{"operationId":"ecommerce_velopayments_resend_payee_invite_v4","summary":"Resend Payee Invite","description":"POST /v4/payees/{payeeId}/invite","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payeeId","body"],"properties":{"payeeId":{"type":"string","description":"The UUID of the payee."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/payee-details-update-v4":{"post":{"operationId":"ecommerce_velopayments_payee_details_update_v4","summary":"Update Payee Details","description":"POST /v4/payees/{payeeId}/payeeDetailsUpdate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payeeId","body"],"properties":{"payeeId":{"type":"string","description":"The UUID of the payee."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/post-v4-payees-payee-id-remote-id-update":{"post":{"operationId":"ecommerce_velopayments_post_v4_payees_payee_id_remote_id_update","summary":"Update Payee Remote Id","description":"POST /v4/payees/{payeeId}/remoteIdUpdate","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payeeId","body"],"properties":{"payeeId":{"type":"string","description":"The UUID of the payee."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-fundings-v4":{"get":{"operationId":"ecommerce_velopayments_get_fundings_v4","summary":"Get Fundings for Payor","description":"GET /v4/paymentaudit/fundings","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The account owner Payor ID","schema":{"type":"string","description":"The account owner Payor ID"}},{"name":"sourceAccountName","in":"query","required":false,"description":"The source account name","schema":{"type":"string","description":"The source account name"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are:…","schema":{"type":"string","description":"List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are:…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-payments-audit-v4":{"get":{"operationId":"ecommerce_velopayments_list_payments_audit_v4","summary":"Get List of Payments","description":"GET /v4/paymentaudit/payments","tags":["ecommerce"],"parameters":[{"name":"payeeId","in":"query","required":false,"description":"The UUID of the payee.","schema":{"type":"string","description":"The UUID of the payee."}},{"name":"payorId","in":"query","required":false,"description":"The account owner Payor Id. Required for external users.","schema":{"type":"string","description":"The account owner Payor Id. Required for external users."}},{"name":"payorName","in":"query","required":false,"description":"The payor’s name. This filters via a case insensitive substring match.","schema":{"type":"string","description":"The payor’s name. This filters via a case insensitive substring match."}},{"name":"remoteId","in":"query","required":false,"description":"The remote id of the payees.","schema":{"type":"string","description":"The remote id of the payees."}},{"name":"remoteSystemId","in":"query","required":false,"description":"The id of the remote system that is orchestrating payments","schema":{"type":"string","description":"The id of the remote system that is orchestrating payments"}},{"name":"status","in":"query","required":false,"description":"Payment Status","schema":{"type":"string","enum":["ACCEPTED","AWAITING_FUNDS","FUNDED","UNFUNDED","BANK_PAYMENT_REQUESTED","REJECTED","ACCEPTED_BY_RAILS","CONFIRMED","FAILED","RETURNED","WITHDRAWN"],"description":"Payment Status"}},{"name":"transmissionType","in":"query","required":false,"description":"Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO","schema":{"type":"string","enum":["ACH","SAME_DAY_ACH","WIRE","LOCAL","GACHO"],"description":"Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO"}},{"name":"sourceAccountName","in":"query","required":false,"description":"The source account name filter. This filters via a case insensitive substring match.","schema":{"type":"string","description":"The source account name filter. This filters via a case insensitive substring match."}},{"name":"sourceAmountFrom","in":"query","required":false,"description":"The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom","schema":{"type":"integer","description":"The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom"}},{"name":"sourceAmountTo","in":"query","required":false,"description":"The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo","schema":{"type":"integer","description":"The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo"}},{"name":"sourceCurrency","in":"query","required":false,"description":"The source currency filter. Filters based on an exact match on the currency.","schema":{"type":"string","description":"The source currency filter. Filters based on an exact match on the currency."}},{"name":"paymentAmountFrom","in":"query","required":false,"description":"The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom","schema":{"type":"integer","description":"The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom"}},{"name":"paymentAmountTo","in":"query","required":false,"description":"The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo","schema":{"type":"integer","description":"The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo"}},{"name":"paymentCurrency","in":"query","required":false,"description":"The payment currency filter. Filters based on an exact match on the currency.","schema":{"type":"string","description":"The payment currency filter. Filters based on an exact match on the currency."}},{"name":"submittedDateFrom","in":"query","required":false,"description":"The submitted date from range filter. Format is yyyy-MM-dd.","schema":{"type":"string","description":"The submitted date from range filter. Format is yyyy-MM-dd."}},{"name":"submittedDateTo","in":"query","required":false,"description":"The submitted date to range filter. Format is yyyy-MM-dd.","schema":{"type":"string","description":"The submitted date to range filter. Format is yyyy-MM-dd."}},{"name":"paymentMemo","in":"query","required":false,"description":"The payment memo filter. This filters via a case insensitive substring match.","schema":{"type":"string","description":"The payment memo filter. This filters via a case insensitive substring match."}},{"name":"railsId","in":"query","required":false,"description":"Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this…","schema":{"type":"string","description":"Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this…"}},{"name":"scheduledForDateFrom","in":"query","required":false,"description":"Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.","schema":{"type":"string","description":"Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd."}},{"name":"scheduledForDateTo","in":"query","required":false,"description":"Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.","schema":{"type":"string","description":"Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd."}},{"name":"scheduleStatus","in":"query","required":false,"description":"Payout Schedule Status","schema":{"type":"string","enum":["ANY","SCHEDULED","EXECUTED","FAILED"],"description":"Payout Schedule Status"}},{"name":"postInstructFxStatus","in":"query","required":false,"description":"The status of the post instruct FX step if one was required for the payment","schema":{"type":"string","enum":["ANY","INITIATED","CANCELLED","EXECUTED","COMPLETED","RETURNED","RESUBMITTED","REFUNDED"],"description":"The status of the post instruct FX step if one was required for the payment"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported…","schema":{"type":"string","description":"List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported…"}},{"name":"sensitive","in":"query","required":false,"description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…","schema":{"type":"boolean","description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payment-details-v4":{"get":{"operationId":"ecommerce_velopayments_get_payment_details_v4","summary":"Get Payment","description":"GET /v4/paymentaudit/payments/{paymentId}","tags":["ecommerce"],"parameters":[{"name":"paymentId","in":"query","required":true,"description":"Payment Id","schema":{"type":"string","description":"Payment Id"}},{"name":"sensitive","in":"query","required":false,"description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…","schema":{"type":"boolean","description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payout-stats-v4":{"get":{"operationId":"ecommerce_velopayments_get_payout_stats_v4","summary":"Get Payout Statistics","description":"GET /v4/paymentaudit/payoutStatistics","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":false,"description":"The account owner Payor ID. Required for external users.","schema":{"type":"string","description":"The account owner Payor ID. Required for external users."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payouts-for-payor-v4":{"get":{"operationId":"ecommerce_velopayments_get_payouts_for_payor_v4","summary":"Get Payouts for Payor","description":"GET /v4/paymentaudit/payouts","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":false,"description":"The id (UUID) of the payor funding the payout or the payor whose payees are being paid.","schema":{"type":"string","description":"The id (UUID) of the payor funding the payout or the payor whose payees are being paid."}},{"name":"payoutMemo","in":"query","required":false,"description":"Payout Memo filter - case insensitive sub-string match","schema":{"type":"string","description":"Payout Memo filter - case insensitive sub-string match"}},{"name":"status","in":"query","required":false,"description":"Payout Status","schema":{"type":"string","enum":["ACCEPTED","REJECTED","SUBMITTED","QUOTED","INSTRUCTED","COMPLETED","INCOMPLETE","CONFIRMED","WITHDRAWN"],"description":"Payout Status"}},{"name":"submittedDateFrom","in":"query","required":false,"description":"The submitted date from range filter. Format is yyyy-MM-dd.","schema":{"type":"string","description":"The submitted date from range filter. Format is yyyy-MM-dd."}},{"name":"submittedDateTo","in":"query","required":false,"description":"The submitted date to range filter. Format is yyyy-MM-dd.","schema":{"type":"string","description":"The submitted date to range filter. Format is yyyy-MM-dd."}},{"name":"fromPayorName","in":"query","required":false,"description":"The name of the payor whose payees are being paid. This filters via a case insensitive substring match.","schema":{"type":"string","description":"The name of the payor whose payees are being paid. This filters via a case insensitive substring match."}},{"name":"scheduledForDateFrom","in":"query","required":false,"description":"Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.","schema":{"type":"string","description":"Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd."}},{"name":"scheduledForDateTo","in":"query","required":false,"description":"Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.","schema":{"type":"string","description":"Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd."}},{"name":"scheduleStatus","in":"query","required":false,"description":"Payout Schedule Status","schema":{"type":"string","enum":["ANY","SCHEDULED","EXECUTED","FAILED"],"description":"Payout Schedule Status"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported…","schema":{"type":"string","description":"List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/get-payments-for-payout-v4":{"get":{"operationId":"ecommerce_velopayments_get_payments_for_payout_v4","summary":"Get Payments for Payout","description":"GET /v4/paymentaudit/payouts/{payoutId}","tags":["ecommerce"],"parameters":[{"name":"railsId","in":"query","required":false,"description":"Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this…","schema":{"type":"string","description":"Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this…"}},{"name":"payoutId","in":"query","required":true,"description":"The id (UUID) of the payout.","schema":{"type":"string","description":"The id (UUID) of the payout."}},{"name":"remoteId","in":"query","required":false,"description":"The remote id of the payees.","schema":{"type":"string","description":"The remote id of the payees."}},{"name":"remoteSystemId","in":"query","required":false,"description":"The id of the remote system that is orchestrating payments","schema":{"type":"string","description":"The id of the remote system that is orchestrating payments"}},{"name":"status","in":"query","required":false,"description":"Payment Status","schema":{"type":"string","enum":["ACCEPTED","AWAITING_FUNDS","FUNDED","UNFUNDED","BANK_PAYMENT_REQUESTED","REJECTED","ACCEPTED_BY_RAILS","CONFIRMED","FAILED","RETURNED","WITHDRAWN"],"description":"Payment Status"}},{"name":"sourceAmountFrom","in":"query","required":false,"description":"The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom","schema":{"type":"integer","description":"The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom"}},{"name":"sourceAmountTo","in":"query","required":false,"description":"The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo","schema":{"type":"integer","description":"The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo"}},{"name":"paymentAmountFrom","in":"query","required":false,"description":"The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom","schema":{"type":"integer","description":"The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom"}},{"name":"paymentAmountTo","in":"query","required":false,"description":"The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo","schema":{"type":"integer","description":"The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo"}},{"name":"submittedDateFrom","in":"query","required":false,"description":"The submitted date from range filter. Format is yyyy-MM-dd.","schema":{"type":"string","description":"The submitted date from range filter. Format is yyyy-MM-dd."}},{"name":"submittedDateTo","in":"query","required":false,"description":"The submitted date to range filter. Format is yyyy-MM-dd.","schema":{"type":"string","description":"The submitted date to range filter. Format is yyyy-MM-dd."}},{"name":"transmissionType","in":"query","required":false,"description":"Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO","schema":{"type":"string","enum":["ACH","SAME_DAY_ACH","WIRE","LOCAL","GACHO"],"description":"Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":25,"description":"The number of results to return in a page"}},{"name":"sort","in":"query","required":false,"description":"List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are:…","schema":{"type":"string","description":"List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are:…"}},{"name":"sensitive","in":"query","required":false,"description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…","schema":{"type":"boolean","description":"Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/export-transactions-csvv4":{"get":{"operationId":"ecommerce_velopayments_export_transactions_csvv4","summary":"Export Transactions","description":"GET /v4/paymentaudit/transactions","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":false,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"startDate","in":"query","required":false,"description":"Start date, inclusive. Format is YYYY-MM-DD","schema":{"type":"string","description":"Start date, inclusive. Format is YYYY-MM-DD"}},{"name":"endDate","in":"query","required":false,"description":"End date, inclusive. Format is YYYY-MM-DD","schema":{"type":"string","description":"End date, inclusive. Format is YYYY-MM-DD"}},{"name":"include","in":"query","required":false,"description":"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…","schema":{"type":"string","enum":["payorOnly","payorAndDescendants"],"description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:velopayments/list-payment-changes-v4":{"get":{"operationId":"ecommerce_velopayments_list_payment_changes_v4","summary":"List Payment Changes","description":"GET /v4/payments/deltas","tags":["ecommerce"],"parameters":[{"name":"payorId","in":"query","required":true,"description":"The Payor ID to find associated Payments","schema":{"type":"string","description":"The Payor ID to find associated Payments"}},{"name":"updatedSince","in":"query","required":true,"description":"The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm","schema":{"type":"string","description":"The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm"}},{"name":"page","in":"query","required":false,"description":"Page number. Default is 1.","schema":{"type":"integer","default":1,"description":"Page number. Default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"The number of results to return in a page","schema":{"type":"integer","default":100,"description":"The number of results to return in a page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}