VoPay Client Accounts API

{"openapi":"3.0.0","info":{"version":"2.0","title":"Client Accounts","description":"The Client Accounts API allows you to create, manage and retrieve information about client accounts.","contact":{"name":"API Support","email":"help@vopay.com"}},"paths":{"/account/client-accounts/individual":{"post":{"description":"Use this endpoint to create a new individual client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers.","summary":"account/client-accounts/individual","tags":["Client Account Creation Endpoints"],"operationId":"ClientAccountIndividualPOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"Custom ID of the client account you want to create","type":"string"},"FirstName":{"description":"Client's first name","type":"string"},"LastName":{"description":"Client's last name","type":"string"},"EmailAddress":{"description":"Client's email address - Must be a valid email","type":"string","format":"email"},"Address1":{"description":"Client's address line 1","type":"string"},"City":{"description":"Client's city","type":"string"},"Province":{"description":"Client's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Client's country specified using full country name or ISO 3166-1 alpha-2 code. If not provided, we will default to the VoPay account's country.","type":"string"},"Nationality":{"description":"Client's nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"},"PostalCode":{"description":"Client's postal code.","type":"string"},"Currency":{"description":"3-character currency code defined by the ISO-4217 standard (e.g. CAD, USD). Used to set the default currency used by this client account. Can be CAD or USD for Canadian accounts. Must be set to USD for US accounts.","type":"string"},"PhoneNumber":{"description":"Client's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"DOB":{"description":"Date of Birth, in date format YYYY-MM-DD (ex: 1960-01-15).","type":"string"},"SINLastDigits":{"description":"Last four digits of the client's SIN number.","type":"integer"},"IdentificationNumber":{"description":"Client's driver's licence.","type":"string"},"Token":{"description":"An iQ11 Token that has been generated using Custom Iframe.","type":"string"},"Label":{"description":"This option will add a Label to the client account. If the Label doesn't exist it will be created and applied.","type":"string"},"FlinksAccountID":{"description":"Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated user and bank account details from Flinks.","type":"string"},"FlinksLoginID":{"description":"Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated user and bank account details from Flinks.","type":"string"},"PlaidProcessorToken":{"description":"Plaid Processor Token. VoPay will fetch the associated user bank account details from Plaid.","type":"string"},"MxProcessorToken":{"description":"Mx Processor Token. VoPay will fetch the associated user bank account details from Mx.","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","EmailAddress","Currency","PhoneNumber","DOB","SINLastDigits"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"Status":{"type":"string","description":"The status of the newly created client account.","example":"ClientAccount1"},"ClientAccountID":{"type":"string","description":"This ID should be saved as it is required in order to perform other actions using the client account such as creating new transactions.","example":"ClientAccount1"},"VerifcationLink":{"type":"string","description":"A link to verify the newly created client account if applicable.","example":"ClientAccount1"}}}}}}}}},"/account/client-accounts/business":{"post":{"description":"Use this endpoint to create a new business client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all business and bank account details from those providers.","summary":"account/client-accounts/business","tags":["Client Account Creation Endpoints"],"operationId":"ClientAccountBusinessPOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"Custom ID of the client account you want to create","type":"string"},"FirstName":{"description":"Client's first name","type":"string"},"LastName":{"description":"Client's last name","type":"string"},"EmailAddress":{"description":"Client's email address - Must be a valid email","type":"string","format":"email"},"Address1":{"description":"Client's address line 1","type":"string"},"City":{"description":"Client's city","type":"string"},"Province":{"description":"Client's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Client's country specified using full country name or ISO 3166-1 alpha-2 code. If not provided, we will default to the VoPay account's country.","type":"string"},"Nationality":{"description":"Client's nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"},"PostalCode":{"description":"Client's postal code.","type":"string"},"Currency":{"description":"3-character currency code defined by the ISO-4217 standard (e.g. CAD, USD). Used to set the default currency used by this client account. Can be CAD or USD for Canadian accounts. Must be set to USD for US accounts.","type":"string"},"BusinessName":{"description":"Business name.","type":"string"},"BusinessNumber":{"description":"Company registration number. A 9-digit number that is unique to a business or legal entity.","type":"string"},"BusinessTypeID":{"description":"ID that represents the company's industry classification. See /account/business-types endpoint for more information.","type":"integer"},"BusinessTypeCategoryID":{"description":"ID that indicates the company's category classification. See /account/business-types endpoint for more information.","type":"integer"},"BusinessWebsite":{"description":"Company's website URL. It must be a valid URL and the protocol must be included (http or https).","type":"string"},"BusinessPhone":{"description":"Company's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"IdentificationNumber":{"description":"Client's federal tax ID. Digits only - no parentheses or dashes allowed.","type":"string"},"Token":{"description":"An iQ11 Token that has been generated using Custom Iframe.","type":"string"},"Label":{"description":"This option will add a Label to the client account. If the Label doesn't exist it will be created and applied.","type":"string"},"FlinksAccountID":{"description":"Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated user and bank account details from Flinks.","type":"string"},"FlinksLoginID":{"description":"Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated user and bank account details from Flinks.","type":"string"},"PlaidProcessorToken":{"description":"Plaid Processor Token. VoPay will fetch the associated user bank account details from Plaid.","type":"string"},"MxProcessorToken":{"description":"Mx Processor Token. VoPay will fetch the associated user bank account details from Mx.","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","EmailAddress","Currency","BusinessName","BusinessNumber","BusinessTypeID","BusinessTypeCategoryID","BusinessWebsite","BusinessPhone"]}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"string","description":"This ID should be saved as it is required in order to perform other actions using the client account such as creating new transactions.","example":"ClientAccount1"}}}}}}}}},"/account/client-accounts/receive-only":{"post":{"description":"Use this endpoint to create a new receive-only client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers. Otherwise, must provide either FirstName/LastName or BusinessName","summary":"account/client-accounts/receive-only","tags":["Client Account Creation Endpoints"],"operationId":"ClientAccountReceiveOnlyPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/ClientAccountReceiveOnlyPOST"},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"string","description":"This ID should be saved as it is required in order to perform other actions using the client account such as creating new transactions.","example":" unt1"}}}}}}}}},"/account/client-accounts/standard":{"post":{"description":"Use this endpoint to create a new standard client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers. Otherwise, must provide either FirstName/LastName or BusinessName","summary":"account/client-accounts/standard","tags":["Client Account Creation Endpoints"],"operationId":"ClientAccountStandardPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/ClientAccountReceiveOnlyPOST"},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"string","description":"This ID should be saved as it is required in order to perform other actions using the client account such as creating new transactions.","example":"ClientAccount1"}}}}}}}}},"/account/client-accounts":{"get":{"description":"This endpoint returns a list of the available client accounts and some of its details.\n\nIt is also possible to filter the list of client accounts by ClientAccountID, its status (active or inactive), and client type (business, individual, receive-only).","summary":"account/client-accounts","tags":["Client Account Management Endpoints"],"operationId":"ClientAccountGET","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientType","in":"query","required":false,"description":"Type of account to be filtered. Use either 'individual', 'business' or 'receive-only'","schema":{"type":"string"}},{"name":"AccountStatus","in":"query","required":false,"description":"Filter by account status. Use true for active accounts and false for inactive.","schema":{"type":"boolean"}},{"name":"ClientAccountID","in":"query","required":false,"description":"Filter by the Client account ID","schema":{"type":"string"}},{"name":"Label","in":"query","required":false,"description":"Filter by the Label","schema":{"type":"string"}},{"name":"Limit ","in":"query","required":false,"description":"Limit the number of records that are returned.","schema":{"type":"integer"}},{"name":"Offset ","in":"query","required":false,"description":"Use this parameter to set the starting point in the dataset.","schema":{"type":"integer"}},{"name":"SearchText","in":"query","required":false,"description":"A text string to search for in the email addresses, names and business number.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccounts":{"type":"object","description":"Collection of Client Accounts data","properties":{"0":{"type":"object","properties":{"ClientAccountID":{"type":"string","description":"Client Account ID of the client account","example":"ClientAccount1"},"ClientType":{"type":"string","description":"Individual, Business or Receive-only","example":""},"ClientName":{"type":"string","description":"First and last name of the client","example":"John Doe"},"EmailAddress":{"type":"string","format":"email","description":"Client Account email address","example":"subaccount.mail@email.com"},"BusinessNumber":{"type":"string","description":"Client Account's business identifier.","example":"123456789"},"BusinessWebsite":{"type":"string","description":"Business website","example":"www.example.com"},"PhoneNumber":{"type":"integer","description":"Client Account's phone number","example":"6045551234"},"BusinessIndustry":{"type":"string","description":"Business Industry name","example":"Retail"},"BusinessCategory":{"type":"string","description":"Business industry category name","example":"Home Electronics"},"DOB":{"type":"integer","description":"Date of Birth, in date format YYYY-MM-DD (ex: 1960-01-15)","example":"1960-01-15"},"SINLastDigits":{"type":"integer","description":"Last four digits of the client's SIN number","example":"1234"},"IsActive":{"type":"boolean","description":"Flag that indicates whether the account is active or not","example":""},"VerificationStatus":{"type":"object","description":"Collection of verification status information","properties":{"Email":{"type":"object","properties":{"Enhanced":{"type":"string","description":"verification status","example":"verified"},"Basic":{"type":"string","description":"verification status","example":"unverified"}}},"Phone":{"type":"object","properties":{"Enhanced":{"type":"string","description":"verification status","example":"verified"}}},"Address":{"type":"object","properties":{"Basic":{"type":"string","description":"verification status","example":"verified"}}}}},"Address1":{"type":"string","description":"Client Account's main address information","example":"112 Bentall Street"},"City":{"type":"string","description":"Client Account's city","example":"Vancouver"},"Province":{"type":"string","description":"Client Account's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Client Account's country specified using full country name or ISO 3166-1 alpha-2 code","example":"Canada"},"Nationality":{"type":"string","description":"The Client's nationality","example":"Canada"},"PostalCode":{"type":"string","description":"Client Account's postal code","example":"A1A1A1"},"IdentificationNumber":{"type":"string","description":"Client's ID (driver's licence or federal tax ID)","example":"I19923"},"ParentAccountID":{"type":"string","description":"Account ID of the account that created the client account","example":"account1"},"Balances":{"type":"object","description":"Collection of Balances per available currency for the client account","properties":{"0":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency for the balance record","example":"CAD"},"Balance":{"type":"string","description":"The total balnace for the currency","example":"25776.73"},"PendingBalance":{"type":"string","description":"The pending balance for the currency","example":"16146.00"}}}}},"Labels":{"type":"object","description":"Collection of Labels associated with the client account","properties":{"0":{"type":"object","properties":{"Label":{"type":"string","description":"The Label value","example":"Billing"},"LabelID":{"type":"string","description":"The ID of the label value","example":"283"}}}}}}}}},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of client account records in that search range.","example":"1000"},"Offset":{"type":"string","description":"Use this parameter to set the starting point in the dataset.","example":"1000"},"Limit":{"type":"string","description":"Limit the number of records that are returned.","example":"1000"}}}}}}}}}}},"/account/client-accounts/balance":{"get":{"description":"This endpoint returns details on the current account balance and available funds for the given Client account.","summary":"account/client-accounts/balance","tags":["Client Account Management Endpoints"],"operationId":"ClientAccountBalanceGet","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":true,"description":"Client account ID of customer who's balance you want to retrieve","schema":{"type":"string"}},{"name":"Currency","in":"query","required":false,"description":"3 character currency code for the currency to fetch transactions for. If this is not specified it will be defaulted to the account's local currency (generally CAD).","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"AccountBalance":{"type":"number","description":"Indicates the total current account balance, including pending funds.","example":"20000.00"},"PendingFunds":{"type":"number","description":"Indicates the portion of the account balance which is pending due to in-progress transactions.","example":"5540.24"},"Reserve":{"type":"number","description":"Indicates the portion of the account balance which is being held as a reserve against returned or fraudulent transactions.","example":"50000.00"},"RollingReserveNSF":{"type":"number","description":"Indicates the portion of the account balance which is being held as a reserve against NSF transactions.","example":"10000.00"},"RollingReserveReturns":{"type":"number","description":"Indicates the portion of the account balance which is being held as a reserve against returned transactions.","example":"1000.00"},"AvailableFunds":{"type":"number","description":"Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds and Reserve amounts.","example":"18000.00"},"OffbookBalance":{"type":"number","description":"Indicates the portion of the account balance which is being held in an off-book account.","example":"1000.00"},"Currency":{"type":"string","description":"3 character currency code for the balance being returned.","example":"CAD"},"Wallets":{"type":"object","description":"Breakdown of balances by wallet. Each wallet is an object with its own balances.","properties":{"0":{"type":"object","properties":{"WalletID":{"type":"string","description":"Unique identifier for the wallet.","example":"wallet_123"},"WalletName":{"type":"string","description":"Name of the wallet.","example":"Wallet 123"},"WalletBalance":{"type":"string","description":"Current wallet balance.","example":"20000.00"},"WalletPendingBalance":{"type":"string","description":"Pending balance for the wallet.","example":"0.00"},"Reserve":{"type":"string","description":"Reserve amount for the wallet.","example":"50000.00"},"RollingReserveNSF":{"type":"string","description":"NSF rolling reserve for the wallet.","example":"10000.00"},"RollingReserveReturns":{"type":"string","description":"Returns rolling reserve for the wallet.","example":"1000.00"},"OffbookBalance":{"type":"string","description":"Offbook balance for the wallet.","example":"1000.00"}}}}}}}}}}}}},"/account/client-accounts/label":{"get":{"description":"This endpoint returns all the created Labels for the given Client account.","summary":"account/client-accounts/label","tags":["Client Account Labels Endpoints"],"operationId":"ClientAccountLabelGet","deprecated":false,"parameters":[{"name":"AccountID","in":"query","required":true,"description":"Your account ID","schema":{"type":"string"}},{"name":"Key","in":"query","required":true,"description":"API key for the account","schema":{"type":"string"}},{"name":"Signature","in":"query","required":true,"description":"Hashed signature for the request","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"Client account ID of customer who's labels you want to retrieve","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"Labels":{"type":"object","description":"Collection of Labels","properties":{"0":{"type":"object","properties":{"Label":{"type":"string","description":"Label Name","example":"ClientAccount1"}}}}}}}}}}}}},"/account/client-accounts/label/add":{"post":{"description":"This endpoint allows you to create a Label.","summary":"account/client-accounts/label/add","tags":["Client Account Labels Endpoints"],"operationId":"ClientAccountLabelAddPost","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"Client account ID of customer who's account we want to add the label to","type":"string"},"Label":{"description":"New Label","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID","Label"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"Label":{"type":"string","description":"The newly added Label","example":""}}}}}}}}},"/account/client-accounts/label/delete":{"post":{"description":"This endpoint allows you to delete a Label.","summary":"account/client-accounts/label/delete","tags":["Client Account Labels Endpoints"],"operationId":"ClientAccountLabelDeletePost","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"Client account ID of customer who's account we want to delete the label from","type":"string"},"Label":{"description":"The label you want to delete","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID","Label"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""}}}}}}}}},"/account/client-accounts/edit":{"post":{"description":"This endpoint allows you to edit the KYC info of the given Client account.","summary":"account/client-accounts/edit","tags":["Client Account Management Endpoints"],"operationId":"ClientAccountEditPost","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"Client account ID of customer who's info you would like to update","type":"string"},"FirstName":{"description":"Client's first name","type":"string"},"LastName":{"description":"Client's last name","type":"string"},"EmailAddress":{"description":"Client's email address - Must be a valid email","type":"string","format":"email"},"BusinessName":{"description":"Business name.","type":"string"},"BusinessNumber":{"description":"Company registration number. A 9-digit number that is unique to a business or legal entity.","type":"string"},"BusinessTypeID":{"description":"ID that represents the company's industry classification. See /account/business-types endpoint for more information.","type":"integer"},"BusinessTypeCategoryID":{"description":"ID that indicates the company's category classification. See /account/business-types endpoint for more information.","type":"integer"},"BusinessWebsite":{"description":"Company's website URL. It must be a valid URL and the protocol must be included (http or https).","type":"string"},"PhoneNumber":{"description":"Company's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Client's address line 1","type":"string"},"City":{"description":"Client's city","type":"string"},"Province":{"description":"Client's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Client's country specified using full country name or ISO 3166-1 alpha-2 code (eg. CA, US).","type":"string"},"Nationality":{"description":"Client's nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.","type":"string"},"PostalCode":{"description":"Client's postal code.","type":"string"},"IdentificationNumber":{"description":"Client's ID (driver's licence or federal tax ID).","type":"string"},"Label":{"description":"This option will add a Label to the client account. If the Label doesn't exist it will be created and applied.","type":"string"},"InteracEtransferPreference":{"description":"This option will update the client's default method used for Interac e-Transfers (eg. email, phone). Only applicable for Canadian VoPay Accounts.","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""}}}}}}}}},"/account/client-accounts/delete":{"post":{"description":"This endpoint will delete an active client account.","summary":"account/client-accounts/delete","tags":["Client Account Management Endpoints"],"operationId":"ClientAccountDeletePOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"ID of the client account to delete","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"integer","description":"The ID of the client account that was just deleted.","example":"1122"},"IsActive":{"type":"boolean","description":"Confirmation that the client account is no longer active","example":"0"},"DateDeleted":{"type":"string","format":"date","description":"","example":"2021-11-03 01:00:00"}}}}}}}}},"/account/client-accounts/deactivate":{"post":{"description":"This endpoint will deactivate an active client account.","summary":"account/client-accounts/deactivate","tags":["Client Account Management Endpoints"],"operationId":"ClientAccountDeactivatePOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"ID of the client account to deactivate","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"integer","description":"The ID of the client account that was just deactivated.","example":"1122"},"IsActive":{"type":"boolean","description":"Confirmation that the client account is no longer active","example":"0"}}}}}}}}},"/account/client-accounts/activate":{"post":{"description":"This endpoint will activate an inactive client account.","summary":"account/client-accounts/activate","tags":["Client Account Management Endpoints"],"operationId":"ClientAccountActivatePOST","deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"AccountID":{"description":"Your account ID","type":"string"},"Key":{"description":"API key for the account","type":"string"},"Signature":{"description":"Hashed signature for the request","type":"string"},"ClientAccountID":{"description":"ID of the client account to activate","type":"string"}},"required":["AccountID","Key","Signature","ClientAccountID"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"ClientAccountID":{"type":"integer","description":"The ID of the client

# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-client-accounts.json