{"openapi":"3.0.0","info":{"version":"2.0","title":"Payment Rails","description":"The Payment Rails API allows you to manage transactions in your account. You can cancel transactions, refund transactions, and confirm flagged transactions.","contact":{"name":"API Support","email":"help@vopay.com"}},"paths":{"/eft/fund":{"post":{"description":"This endpoint is used to fund your VoPay account by debiting funds from the specified customer's bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided. \n\n If either Token, Flinks (FlinksAccountID, FlinksLoginID), Inverite (InveriteRequestGUID), or Plaid (PlaidPublicToken/PlaidAccessToken, PlaidAccountID) is provided, the FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber will not be required. \n\n If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.\n\n If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.","summary":"eft/fund","tags":["EFT Endpoint"],"operationId":"EftFundPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"City":{"description":"Customer's city","type":"string"},"Province":{"description":"Customer's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"PostalCode":{"description":"Customer's postal code.","type":"string"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"string"},"FinancialInstitutionNumber":{"description":"Three digit institution number for a Canadian bank.","type":"string"},"BranchTransitNumber":{"description":"Transit number for the customer's account.","type":"string"},"Amount":{"description":"The amount to debit from the customer's bank account.","type":"number"},"Currency":{"description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency.  NOTE: Currently the eft/fund API endpoint only supports CAD and USD transactions.","type":"string"},"Iq11VerificationLevelID":{"description":"Iq11 verification level ID. Accepted values are: 1 (no NSF check), 2 (NSF check done at time of transaction), 3 (NSF check done prior to processing the transaction), and 4 (NSF check done at the time of transaction and prior to processing the transaction). Value is defaulted to the default value set on the account.","type":"integer"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transaction.","type":"string"},"FlinksAccountID":{"description":"Used by clients with a Flinks account","type":"string"},"FlinksLoginID":{"description":"Used by clients with a Flinks account","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"PlaidPublicToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccessToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccountID":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidProcessorToken":{"description":"Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary","type":"string"},"MxAuthorizationCode":{"description":"Used by clients with an MX account.","type":"string"},"InveriteRequestGUID":{"description":"Used by clients with an Inverite account","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"},"TransactionLabel":{"description":"TransactionLabel overrides originator short name","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"WalletID":{"description":"The ID of the wallet to associate with the transaction. Requires ClientAccountID to be provided.","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","CompanyName","Address1","City","Province","Country","PostalCode","AccountNumber","FinancialInstitutionNumber","BranchTransitNumber","Amount","Currency"]}}},"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":""},"TransactionID":{"type":"integer","description":"This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"},"Flagged":{"type":"string","description":"Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.","example":"The transaction has been flagged as a potential duplicate.","x-absent-when":"transaction not flagged"},"Iq11":{"type":"boolean","description":"True if the transaction was an iq11 transaction, false if it is not.","example":true}},"required":["Success","ErrorMessage","TransactionID","Iq11"]}}}}}}},"/eft/fund/status":{"get":{"description":"This endpoint is used to look up the status of a fund transaction.","summary":"eft/fund/status","tags":["EFT Endpoint"],"operationId":"EftFundStatusGet","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":"TransactionID","in":"query","required":true,"description":"The unique ID of the transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"SubTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of sub-transactions related to the main transaction","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"Unique ID for the Transaction","example":"5918"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled, waiting on required transaction","example":"waiting on required transaction"},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp when the transaction status was last modified","example":"2019-11-01 12:00:00"}},"required":["TransactionID","TransactionStatus","Timestamp"]}},"x-absent-when":"transaction has no child transactions","x-list-of":"inline","x-empty-when":"no items"},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp when the transaction status was last modified","example":"2019-11-01 12:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/eft/fund/transaction":{"get":{"description":"This endpoint is used to look up and return the full details on a single fund transaction. Fund transactions take money out of the customer's bank account and deposit them into your account.","summary":"eft/fund/transaction","tags":["EFT Endpoint"],"operationId":"EftFundTransactionGet","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":"TransactionID","in":"query","required":true,"description":"The unique ID of the fund transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the fund transaction. This is the amount that was withdrawn from the customer's bank account.","example":"1200"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"HoldAmount":{"type":"number","description":"Indicates if any of the funds that were credited to your account are still being held.","example":"1200"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-02 01:00:21"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Customer's first name","example":"John"},"LastName*":{"type":"string","description":"Customer's last name","example":"Doe"},"Address1":{"type":"string","description":"Customer's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Customer's address line 2","example":""},"City":{"type":"string","description":"Customer's city","example":"Vancouver"},"Province/State":{"type":"string","description":"Customer's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code","example":"Canada"},"PostalCode/Zipcode":{"type":"string","description":"Customer's postal code.","example":"V4W 5Z7"},"FinancialInstitutionNumber":{"type":"string","description":"Three digit institution number for a Canadian bank.","example":"112"},"BranchTransitNumber":{"type":"string","description":"Transit number for the customer's account.","example":"11456"},"AccountNumber":{"type":"string","description":"Customer's bank account number that funds were debited from.","example":"1100456342"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":"876432"},"ScheduledTransactionID":{"type":"integer","description":"Id of the scheduled transaction. This field only will be displayed if the scheduled transaction exists.","example":"1"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"SubTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of sub-transactions related to the main transaction","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"9826"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled, waiting on required transaction","example":"waiting on required transaction"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the fund transaction. This is the amount that was withdrawn from the customer's bank account.","example":"100"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"HoldAmount":{"type":"number","description":"Indicates if any of the funds that were credited to your account are still being held.","example":"100"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-02 01:00:21"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Customer's first name","example":"John"},"LastName*":{"type":"string","description":"Customer's last name","example":"Doe"},"Address1":{"type":"string","description":"Customer's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Customer's address line 2","example":""},"City":{"type":"string","description":"Customer's city","example":"Vancouver"},"Province":{"type":"string","description":"Customer's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code","example":"Canada"},"PostalCode":{"type":"string","description":"Customer's postal code.","example":"V4W 5Z7"},"FinancialInstitutionNumber":{"type":"string","description":"Three digit institution number for a Canadian bank.","example":"112"},"BranchTransitNumber":{"type":"string","description":"Transit number for the customer's account.","example":"11456"},"AccountNumber":{"type":"string","description":"Customer's bank account number that funds were debited from.","example":"1100456342"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":"876432"}},"required":["TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName*","Address1","Address2","City","Province","Country","PostalCode","FinancialInstitutionNumber","BranchTransitNumber","AccountNumber","ClientReferenceNumber"]}},"x-absent-when":"transaction has no child transactions","x-list-of":"inline","x-empty-when":"no items"},"HoldReleaseDateTime":{"type":"string","format":"date-time","description":"This timestamp indicates when the 'HoldAmount' funds will be released in EST.","example":"2019-11-02 23:59:59"},"PayLinkDetails":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of TransactionInfo data","properties":{"0":{"type":"object","properties":{"FirstName":{"type":"string","description":"Customer's first name","example":"John"},"LastName":{"type":"string","description":"Customer's last name","example":"Doe"},"EmailAddress":{"type":"string","description":"Recipient's email address.","example":"john.doe@vopay.com"},"InvoiceNumber":{"type":"string","description":"Invoice number","example":"ABC1234"},"Note":{"type":"string","description":"If applicable, notes giving context to the transaction.","example":"Paylink requested to the client 123"},"SenderName":{"type":"string","description":"Sender's full name.","example":"John Doe"},"PayLinkStatus":{"type":"string","description":"Status of the Paylink request","example":"pending"},"FailureReason":{"type":"string","description":"Detailed description of why the paylink request failed.","example":""},"PayLinkCreated":{"type":"string","format":"date","description":"","example":"2019-11-03 01:00:00"}},"required":["FirstName","LastName","EmailAddress","InvoiceNumber","Note","SenderName","PayLinkStatus","FailureReason","PayLinkCreated"]}},"x-empty-when":"no pay-link details","x-list-of":"inline"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName*","Address1","Address2","City","Province/State","Country","PostalCode/Zipcode","FinancialInstitutionNumber","BranchTransitNumber","AccountNumber","ClientReferenceNumber","ScheduledTransactionID","TransactionTypeCode","HoldReleaseDateTime","PayLinkDetails","GLCode"]}}}}}}},"/eft/withdraw":{"post":{"description":"This endpoint is used to take funds out of your VoPay account, and deposit them to the specified recipient's bank account. In the below endpoint, either CompanyName OR FirstName and LastName must be provided. \n\n If either Token, Flinks (FlinksAccountID, FlinksLoginID), Inverite (InveriteRequestGUID), or Plaid (PlaidPublicToken/PlaidAccessToken, PlaidAccountID) is provided, then the FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber will not be required. \n\n If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Province, Country, and PostalCode are required.\n\n If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.","summary":"eft/withdraw","tags":["EFT Endpoint"],"operationId":"EftWithdrawPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Recipient's first name","type":"string"},"LastName":{"description":"Recipient's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"Address1":{"description":"Recipient's address line 1","type":"string"},"City":{"description":"Recipient's city","type":"string"},"Province":{"description":"Recipient's province specified using two character abbreviation (eg. BC, AB)","type":"string"},"Country":{"description":"Recipient's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"PostalCode":{"description":"Recipient's postal code.","type":"string"},"AccountNumber":{"description":"Recipient's bank account number. This is the account that funds will be deposited into.","type":"string"},"FinancialInstitutionNumber":{"description":"Canadian banks. Three digit institution number.","type":"string"},"BranchTransitNumber":{"description":"Canadian banks. Transit number for the Recipient's account.","type":"string"},"Amount":{"description":"The amount in the specified currency to deposit into the recipient's bank account.","type":"number"},"Currency":{"description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency. NOTE: Currently the eft/withdraw API endpoint only supports CAD and USD transactions","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transaction.","type":"string"},"FlinksAccountID":{"description":"Used by clients with a Flinks account","type":"string"},"FlinksLoginID":{"description":"Used by clients with a Flinks account","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"PlaidPublicToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccessToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccountID":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidProcessorToken":{"description":"Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary","type":"string"},"MxAuthorizationCode":{"description":"Used by clients with an MX account.","type":"string"},"InveriteRequestGUID":{"description":"Used by clients with an Inverite account","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"},"TransactionLabel":{"description":"TransactionLabel overrides originator short name","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","CompanyName","Address1","City","Province","Country","PostalCode","AccountNumber","FinancialInstitutionNumber","BranchTransitNumber","Amount","Currency"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"},"Flagged":{"type":"string","description":"Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.","example":"The transaction has been flagged as a potential duplicate.","x-absent-when":"transaction not flagged"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/eft/withdraw/transaction":{"get":{"description":"This endpoint is used to look up details on a single withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account.","summary":"eft/withdraw/transaction","tags":["EFT Endpoint"],"operationId":"EftWithdrawTransactionGet","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":"TransactionID","in":"query","required":true,"description":"Unique ID of the withdraw transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"HoldAmount":{"type":"number","description":"Will always be 0 for withdraw transactions, however parameter is included to keep return data format consistent with the format used for fund transactions.","example":"2000"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances withdraw transaction record will not be modified.","example":"2019-11-03 01:00:00"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Recipient's first name","example":"John"},"LastName":{"type":"string","description":"Recipient's last name","example":"Doe"},"Address1":{"type":"string","description":"Recipient's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Recipient's address line 2","example":""},"City":{"type":"string","description":"Recipient's city","example":"Vancouver"},"Province":{"type":"string","description":"Recipient's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Recipient's country specified using full country name.","example":"Canada"},"PostalCode":{"type":"string","description":"Recipient's postal code.","example":"V2W 4V6"},"FinancialInstitutionNumber":{"type":"string","description":"Three digit institution number for a Canadian bank.","example":"112"},"BranchTransitNumber":{"type":"string","description":"Transit number for the customer's account.","example":"11809"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"227654387"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"PayLinkDetails":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of TransactionInfo data","properties":{"0":{"type":"object","properties":{"FirstName":{"type":"string","description":"Customer's first name","example":"John"},"LastName":{"type":"string","description":"Customer's last name","example":"Doe"},"EmailAddress":{"type":"string","description":"Recipient's email address.","example":"john.doe@vopay.com"},"InvoiceNumber":{"type":"string","description":"Invoice number","example":"ABC1234"},"Note":{"type":"string","description":"If applicable, notes giving context to the transaction.","example":"Paylink requested to the client 123"},"SenderName":{"type":"string","description":"Sender's full name.","example":"John Doe"},"PayLinkStatus":{"type":"string","description":"Status of the Paylink request","example":"pending"},"FailureReason":{"type":"string","description":"Detailed description of why the paylink request failed.","example":""},"PayLinkCreated":{"type":"string","format":"date","description":"","example":"2019-11-03 01:00:00"}},"required":["FirstName","LastName","EmailAddress","InvoiceNumber","Note","SenderName","PayLinkStatus","FailureReason","PayLinkCreated"]}},"x-empty-when":"no pay-link details","x-list-of":"inline"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName","Address1","Address2","City","Province","Country","PostalCode","FinancialInstitutionNumber","BranchTransitNumber","AccountNumber","ClientReferenceNumber","TransactionTypeCode","PayLinkDetails","GLCode"]}}}}}}},"/eft/withdraw/status":{"get":{"description":"This endpoint is used to look up the status of a withdraw transaction.","summary":"eft/withdraw/status","tags":["EFT Endpoint"],"operationId":"EftWithdrawStatusGet","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":"TransactionID","in":"query","required":true,"description":"The unique ID of the withdraw transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp when the transaction status was last modified","example":"2019-11-02 12:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/eft/fund/schedule":{"post":{"description":"This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. \n\nEither CompanyName OR FirstName and LastName must be provided. \n\n If either Token, Flinks (FlinksAccountID, FlinksLoginID), Inverite (InveriteRequestGUID), or Plaid (PlaidPublicToken/PlaidAccessToken, PlaidAccountID) is provided, the FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber will not be required. \n\n If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.\n\n If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.\n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment.","summary":"eft/fund/schedule","tags":["EFT Endpoint"],"operationId":"EftSchedulePOST","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","type":"string"},"Amount":{"description":"The amount to schedule in the transactions","type":"number"},"Frequency":{"description":"The frequency of the scheduled transaction: single or recurring.","type":"string"},"NameOfFrequency":{"description":"Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly.","type":"string"},"ScheduleStartDate":{"description":"Date from which the schedule will be started","type":"string"},"ScheduleEndDate":{"description":"Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"string"},"EndingAfterPayments":{"description":"Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"integer"},"SemiMonthlyFrequencyType":{"description":"Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast","type":"integer"},"Description":{"description":"Description of the schedule transaction","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"City":{"description":"Customer's city","type":"string"},"Province":{"description":"Customer's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"PostalCode":{"description":"Customer's postal code.","type":"string"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"string"},"FinancialInstitutionNumber":{"description":"Three digit institution number for a Canadian bank.","type":"string"},"BranchTransitNumber":{"description":"Transit number for the customer's account.","type":"string"},"Currency":{"description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transaction.","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"FlinksAccountID":{"description":"Used by clients with a Flinks account","type":"string"},"FlinksLoginID":{"description":"Used by clients with a Flinks account","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"PlaidPublicToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccessToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccountID":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidProcessorToken":{"description":"Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary","type":"string"},"MxAuthorizationCode":{"description":"Used by clients with an MX account.","type":"string"},"InveriteRequestGUID":{"description":"Used by clients with an Inverite account","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"}},"required":["AccountID","Key","Signature","Amount","Frequency","NameOfFrequency","ScheduleStartDate","ScheduleEndDate","EndingAfterPayments","Description","FirstName","LastName","CompanyName","Address1","City","Province","Country","PostalCode","AccountNumber","FinancialInstitutionNumber","BranchTransitNumber","Currency"]}}},"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":""},"Amount":{"type":"number","description":"The dollar amount of the schedule transaction","example":"200.00"},"ScheduledTransactionID":{"type":"integer","description":"ID of the schedule Transaction.","example":"1122"},"Frequency":{"type":"string","description":"The frequency of the transaction","example":"single"},"Description":{"type":"string","description":"Description of the schedule transaction","example":""},"ScheduleStartDate":{"type":"string","format":"date","description":"Date from which the transaction will be started ","example":"2020-01-01"},"Status":{"type":"string","description":"A message indicating the current transaction status. Statuses are: cancelled, completed or in progress","example":"in progress"}},"required":["Success","ErrorMessage","Amount","ScheduledTransactionID","Frequency","Description","ScheduleStartDate","Status"]}}}}}}},"/eft/withdraw/schedule":{"post":{"description":"This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. \n\nEither CompanyName OR FirstName and LastName must be provided. \n\n If either Token, Flinks (FlinksAccountID, FlinksLoginID), Inverite (InveriteRequestGUID), or Plaid (PlaidPublicToken/PlaidAccessToken, PlaidAccountID) is provided, the FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber will not be required. \n\n If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.\n\n If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.\n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment.","summary":"eft/withdraw/schedule","tags":["EFT Endpoint"],"operationId":"EftWithdrawSchedulePOST","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","type":"string"},"Amount":{"description":"The amount to schedule in the transactions","type":"number"},"Frequency":{"description":"The frequency of the scheduled: single or recurring.","type":"string"},"NameOfFrequency":{"description":"Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly.","type":"string"},"ScheduleStartDate":{"description":"Date from which the schedule will be started","type":"string"},"ScheduleEndDate":{"description":"Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"string"},"EndingAfterPayments":{"description":"Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"integer"},"SemiMonthlyFrequencyType":{"description":"Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast","type":"integer"},"Description":{"description":"Description of the schedule transaction","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"City":{"description":"Customer's city","type":"string"},"Province":{"description":"Customer's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"PostalCode":{"description":"Customer's postal code.","type":"string"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"string"},"FinancialInstitutionNumber":{"description":"Three digit institution number for a Canadian bank.","type":"string"},"BranchTransitNumber":{"description":"Transit number for the customer's account.","type":"string"},"Currency":{"description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transaction.","type":"string"},"FlinksAccountID":{"description":"Used by clients with a Flinks account","type":"string"},"FlinksLoginID":{"description":"Used by clients with a Flinks account","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"PlaidPublicToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccessToken":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidAccountID":{"description":"Used by clients with a Plaid account","type":"string"},"PlaidProcessorToken":{"description":"Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary","type":"string"},"MxAuthorizationCode":{"description":"Used by clients with an MX account.","type":"string"},"InveriteRequestGUID":{"description":"Used by clients with an Inverite account","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"}},"required":["AccountID","Key","Signature","Amount","Frequency","NameOfFrequency","ScheduleStartDate","ScheduleEndDate","EndingAfterPayments","Description","FirstName","LastName","CompanyName","Address1","City","Province","Country","PostalCode","AccountNumber","FinancialInstitutionNumber","BranchTransitNumber","Currency"]}}},"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":""},"Amount":{"type":"number","description":"The dollar amount of the schedule transaction","example":"200.00"},"ScheduledTransactionID":{"type":"integer","description":"ID of the schedule Transaction.","example":"1122"},"Frequency":{"type":"string","description":"The frequency of the transaction","example":"single"},"Description":{"type":"string","description":"Description of the schedule transaction","example":""},"ScheduleStartDate":{"type":"string","format":"date","description":"Date from which the transaction will be started ","example":"2020-01-01"},"Status":{"type":"string","description":"A message indicating the current transaction status. Statuses are: cancelled, pending approval, completed or in progress","example":"in progress"}},"required":["Success","ErrorMessage","Amount","ScheduledTransactionID","Frequency","Description","ScheduleStartDate","Status"]}}}}}}},"/eft/fund/schedule/cancel":{"post":{"description":"This endpoint is used to cancel a scheduled transaction and all remaining payments belonging to that scheduled tranaction. Only scheduled transactions with the status in progress can be cancelled. \n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment","summary":"eft/fund/schedule/cancel","tags":["EFT Endpoint"],"operationId":"EftScheduleCancelPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/EftScheduleCancelPOST"},"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":""},"Status":{"type":"string","description":"A message indicating the current transaction status. cancelled","example":"cancelled"}},"required":["Success","ErrorMessage","Status"]}}}}}}},"/eft/withdraw/schedule/cancel":{"post":{"description":"This endpoint is used to cancel a scheduled transaction and all remaining payments belonging to that scheduled tranaction. Only scheduled transactions with the status in progress can be cancelled. \n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment","summary":"eft/withdraw/schedule/cancel","tags":["EFT Endpoint"],"operationId":"EftWithdrawScheduleCancelPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/EftScheduleCancelPOST"},"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":""},"Status":{"type":"string","description":"A message indicating the current transaction status. cancelled","example":"cancelled"}},"required":["Success","ErrorMessage","Status"]}}}}}}},"/eft/fund/schedule/edit":{"post":{"description":"This endpoint is used to edit or cancel an upcoming payment (only the amount can be edited). \n\nNotes. If the field amount is set as 0 or it is not provided, we consider the upcoming payment as cancelled. \n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment","summary":"eft/fund/schedule/edit","tags":["EFT Endpoint"],"operationId":"EftScheduleEditPOST","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"},"ScheduledTransactionID":{"description":"ID of the schedule transaction to edit","type":"integer","format":"int32"},"Amount":{"description":"The new amount of the upcoming payment to edit, If this value is 0 we consider that upcoming payment as cancelled","type":"number"},"UpcomingPayment":{"description":"The date of the upcoming payment. This payment has to belong to the list of upcoming payments of the scheduled transaction to edit.","type":"string","format":"date"}},"required":["AccountID","Key","Signature","ScheduledTransactionID","UpcomingPayment"]}}},"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":""}},"required":["Success","ErrorMessage"]}}}}}}},"/eft/withdraw/schedule/edit":{"post":{"description":"This endpoint is used to edit or cancel an upcoming payment (only the amount can be edited). \n\nNotes. If the field amount is set as 0 or it is not provided, we consider the upcoming payment as cancelled. \n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment","summary":"eft/withdraw/schedule/edit","tags":["EFT Endpoint"],"operationId":"EftWithdrawScheduleEditPOST","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"},"ScheduledTransactionID":{"description":"ID of the schedule transaction to edit","type":"integer","format":"int32"},"Amount":{"description":"The new amount of the upcoming payment to edit, If this value is 0 we consider that upcoming payment as cancelled","type":"number"},"UpcomingPayment":{"description":"The date of the upcoming payment. This payment has to belong to the list of upcoming payments of the scheduled transaction to edit.","type":"string","format":"date"},"NewDate":{"description":"The new date of the upcoming payment. This will update the UpcomingPayment date for this particular payment. Note that the UpcomingPayment date for all other payments, that belongs to the same scheduled transaction, will not be affected.","type":"string","format":"date"}},"required":["AccountID","Key","Signature","ScheduledTransactionID","UpcomingPayment","NewDate"]}}},"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":""}},"required":["Success","ErrorMessage"]}}}}}}},"/eft/scheduled-transactions":{"get":{"description":"This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction. \n\n If the value ScheduledTransactionID is present, we only list the details of that scheduled transaction.  \n\n * Either the response will be Company name or First name and Last name","summary":"eft/scheduled-transactions","tags":["EFT Endpoint"],"operationId":"EftScheduledTransactionGet","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","schema":{"type":"string"}},{"name":"ScheduledTransactionID","in":"query","required":true,"description":"ID of the schedule Transaction (If this value is present, we list the details of the scheduled transactions)","schema":{"type":"integer","format":"int32"}},{"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"}}],"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":""},"NumberOfRecords":{"type":"number","description":"Total number of the scheduled transaction records returned","example":"1"},"ScheduledTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of scheduled Transaction info data","properties":{"0":{"type":"object","properties":{"ID":{"type":"integer","description":"Unique ID for the scheduled transaction","example":"15"},"Type":{"type":"string","description":"The payment type of scheduled transaction; i.e., funding or withdraw","example":"funding"},"Amount":{"type":"number","description":"The amount of the scheduled transaction","example":"25.00"},"Frequency":{"type":"string","description":"The frequency of the schedule: single or recurring","example":"recurring"},"Description":{"type":"string","description":"Description of the scheduled transaction","example":"Scheduled transaction 1234"},"Notes":{"type":"string","description":"Note that will be attached to each scheduled transaction","example":"Loan repayment 1234"},"NameOfFrequency":{"type":"string","description":"Name of the frequency of the transaction: weekly, biweekly, monthly, bimonthly, 3 months, 6 months, yearly. Only provided if Frequency provided is recurring.","example":"weekly"},"Status":{"type":"string","description":"A message indicating the current transaction status. Statuses are: cancelled, completed, or in progress","example":"in progress"},"StartDate":{"type":"string","format":"date","description":"Date from which the transaction will be started","example":"2020-01-01"},"EndDate":{"type":"string","format":"date","description":"Date from which the transaction will end","example":"2021-01-01"},"EndingAfterPayments":{"type":"integer","description":"Number of payments after which the transaction processing will end","example":"12"},"ScheduledDetails":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction","properties":{"0":{"type":"object","properties":{"FlinksAccountID":{"type":"string","description":"Used by clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksLoginID":{"type":"string","description":"Used by clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"Token":{"type":"string","description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidAccessToken":{"type":"string","description":"Used by clients with a Plaid account","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidAccountID":{"type":"string","description":"Used by clients with a Plaid account","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidPublicToken":{"type":"string","description":"Used by clients with a Plaid account","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidProcessorToken":{"type":"string","description":"Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary","example":"ACBDF-GAFSHD-AHBS-123456"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"*****387"},"FinancialInstitutionNumber":{"type":"string","description":"Three digit institution number for a Canadian bank.","example":"112"},"BranchTransitNumber":{"type":"string","description":"Transit number for the customer's account.","example":"**809"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Customer's first name","example":"John"},"LastName*":{"type":"string","description":"Customer's last name","example":"Doe"},"Address1":{"type":"string","description":"Recipient's address line 1","example":"112 Bentall Street"},"City":{"type":"string","description":"Recipient's city","example":"Vancouver"},"PostalCode":{"type":"string","description":"Recipient's postal code.","example":"V2W 4V6"},"Province":{"type":"string","description":"Recipient's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Recipient's country specified using full country name.","example":"Canada"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"ErrorMessage":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction payments, this is the log of the failures","properties":{"0":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":false},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""}},"required":["Success","ErrorMessage"]}},"x-list-of":"inline","x-empty-when":"no items"}},"required":["FlinksAccountID","FlinksLoginID","Token","PlaidAccessToken","PlaidAccountID","PlaidPublicToken","PlaidProcessorToken","AccountNumber","FinancialInstitutionNumber","BranchTransitNumber","CompanyName*","FirstName*","LastName*","Address1","City","PostalCode","Province","Country","ClientReferenceNumber","ErrorMessage"]}},"x-list-of":"inline","x-empty-when":"no items"},"UpcomingTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Upcoming transaction listing (This option only will be available if the user provides ScheduledTransactionID as a parameter)","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"ID of the eft transaction (Empty because it is a future payment)","example":""},"ScheduledDate":{"type":"string","format":"date","description":"Date from which the payment will start","example":"2020-01-01"},"ProcessingDate":{"type":"string","format":"date","description":"Date where this payment was processed (Empty because it is a future payment)","example":""},"LastModified":{"type":"string","format":"date","description":"Date of the last modification of this payment (Empty because it is a future payment)","example":""},"Status":{"type":"string","description":"Status of the upcoming payment (Empty because it is a future payment)","example":""},"Amount":{"type":"number","description":"The amount of the scheduled transaction","example":"10.00"}},"required":["TransactionID","ScheduledDate","ProcessingDate","LastModified","Status","Amount"]}},"x-list-of":"inline","x-empty-when":"no items"},"CompletedTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... List of the completed transactions (This option only will be available if the user provides ScheduledTransactionID as a parameter)","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"ID of the EFT transaction","example":"1"},"ScheduledDate":{"type":"string","format":"date","description":"Date from which the transaction will start","example":"2020-01-01"},"ProcessingDate":{"type":"string","format":"date","description":"Date where this transaction was processed","example":"2020-01-02"},"LastModified":{"type":"string","format":"date","description":"Date of the last modification of this transaction","example":"2020-01-02"},"Status":{"type":"string","description":"Status of the transaction","example":"pending"},"Amount":{"type":"number","description":"The amount of the transaction","example":"10.00"}},"required":["TransactionID","ScheduledDate","ProcessingDate","LastModified","Status","Amount"]}},"x-list-of":"inline","x-empty-when":"no items"}},"required":["ID","Type","Amount","Frequency","Description","Notes","NameOfFrequency","Status","StartDate","EndDate","EndingAfterPayments","ScheduledDetails","UpcomingTransactions","CompletedTransactions"]}},"x-empty-when":"no scheduled transactions match","x-list-of":"inline"},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of transaction 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"}},"x-absent-when":"no pagination metadata available","required":["TotalRecords","Offset","Limit"]}},"required":["Success","ErrorMessage","NumberOfRecords","ScheduledTransactions"]}}}}}}},"/eft/failures":{"get":{"description":"This endpoint is used to retrieve a list of transactions which failed during a specific date range. This endpoint is queried based on the date that a failure occurred on, not on the date when the transaction originally occurred.","summary":"eft/failures","tags":["EFT Endpoint"],"operationId":"EftFailuresGet","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":"StartDateTime","in":"query","required":true,"description":"Start of date range to query for any failed transactions","schema":{"type":"string","format":"date-time"}},{"name":"EndDateTime","in":"query","required":true,"description":"End of date range to query for any failed transactions","schema":{"type":"string","format":"date-time"}}],"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":""},"NumberOfRecords":{"type":"number","description":"Total number of failed transaction records returned","example":"1"},"FailedTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of TransactionInfo data","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"Unique ID for the Transaction","example":"5918"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp on which the transaction occurred.","example":"2019-12-04 18:13:39"},"TransactionType":{"type":"string","description":"Specifies the type of transaction, for example 'EFT Funding', 'EFT Withdrawal'.","example":"EFT Funding"},"DollarAmount":{"type":"number","description":"The dollar amount of the failed transaction.","example":"25.00"},"ErrorCode":{"type":"string","description":"Detail error code of the failure.","example":"901"},"FailureReason":{"type":"string","description":"Detailed description of why the transaction failed. Transactions which have failed cannot be modified, a new fund or withdraw transaction must be created if you wish to re-attempt the transaction.","example":"insufficient funds"},"ClientReferenceNumber":{"type":"string","description":"The optional reference number which was set when the transaction was created.","example":"null"}},"required":["TransactionID","TransactionDateTime","TransactionType","DollarAmount","ErrorCode","FailureReason","ClientReferenceNumber"]}},"x-empty-when":"no failed transactions match","x-list-of":"inline"}},"required":["Success","ErrorMessage","NumberOfRecords","FailedTransactions"]}}}}}}},"/credit-card/charge":{"post":{"description":"This endpoint is to create a credit card transaction to fund your VoPay account, charging the amount specified to the credit card linked to the provided CreditCardToken.\n\n If a ClientAccountID is provided, the client account's default credit card will be used for the transaction.\n\nNote: You must first generate a CreditCardToken using the /credit-card/generate-embed-url endpoint.","summary":"credit-card/charge","tags":["Credit Card Endpoints"],"operationId":"CreditCardChargePOST","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"CreditCardToken":{"description":"The token identifying the credit card to charge (returned from /credit-card/generate-embed-url).","type":"string"},"Amount":{"description":"The amount to charge from the customer's credit card.","type":"number"},"Currency":{"description":"3 character currency code for the currency to be charged into the customer credit card. If this is not specified the transaction will use the account's local currency (CAD).","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code. If this is not specified the transaction will use the local country (CA).","type":"string"},"ClientReferenceNumber":{"description":"Optional reference number for the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"},"TransactionLabel":{"description":"Statement descriptor. Max 25 chars.","type":"string"}},"required":["AccountID","Key","Signature","CreditCardToken","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/credit-card/void":{"post":{"description":"This endpoint allows you to void a completed credit card transaction.","summary":"credit-card/void","tags":["Credit Card Endpoints"],"operationId":"CreditCardVoidPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/CreditCardVoidPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the void transaction","example":"1124"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/credit-card/charge/transaction":{"get":{"description":"This method is used to look up and return the full details on a single credit card transaction. Credit card transactions take money out of the customer's credit card and deposit them into your VoPay account.","summary":"credit-card/charge/transaction","tags":["Credit Card Endpoints"],"operationId":"CreditCardChargeTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: successful, failed, cancelled, settled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the credit card transaction. This is the amount that was withdrawn from the customer's credit card.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"CreditCardToken":{"type":"string","description":"A unique token who has the credit card information. Note. For security purposes we do not store the customer credit card information.","example":"ACBDF-GAFSHD-AHBS-123456"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code.","example":"CA"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-03 01:00:00"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","CreditCardToken","Country","GLCode","LastModified","TransactionTypeCode"]}}}}}}},"/debit-card/oct/push-funds":{"post":{"description":"This endpoint is used to instantly send funds from your VoPay account to the debit card linked to the provided CardToken.\n\n If a ClientAccountID is provided, the client account's default card will be used for the transaction.\n\nNote: You must first generate a CardToken using the /debit-card/generate-embed-url endpoint.","summary":"debit-card/oct/push-funds","tags":["Debit Card Endpoints"],"operationId":"OCTPushFundsPOST","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","type":"string"},"CardToken":{"description":"The token identifying the debit card to charge (returned from /debit-card/generate-embed-url).","type":"string"},"Amount":{"description":"The amount to send to the customer's debit card.","type":"number"},"Currency":{"description":"3 character currency code for the currency to sent to the customer's debit card. If this is not specified the transaction will use the account's local currency (CAD).","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","CardToken","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/debit-card/oct/transaction":{"get":{"description":"This method is used to look up and return the full details on a single OCT transaction. OCT transactions sends money from your VoPay account directly onto the customer's debit card.","summary":"debit-card/oct/transaction","tags":["Debit Card Endpoints"],"operationId":"OCTPushFundsTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: successful, failed, rejected","example":"successful"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the transaction. This is the amount that was sent to the customer's debit card.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"PushToCardToken":{"type":"string","description":"A unique token who has the card information. Note. For security purposes we do not store the customer debit card information.","example":"ACBDF-GAFSHD-AHBS-123456"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code.","example":"CA"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes.","example":"2023-11-03 01:00:00"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","PushToCardToken","Country","LastModified","GLCode","TransactionTypeCode"]}}}}}}},"/debit-card/aft/pull-funds":{"post":{"description":"This endpoint is used to instantly pull funds from your debit card linked to the provided CardToken to fund your VoPay account.\n\n If a ClientAccountID is provided, the client account's default card will be used for the transaction.\n\nNote: You must first generate a CardToken using the /debit-card/generate-embed-url endpoint.","summary":"debit-card/aft/pull-funds","tags":["Debit Card Endpoints"],"operationId":"AFTPullFundsPOST","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","type":"string"},"CardToken":{"description":"The token identifying the debit card to charge (returned from /debit-card/generate-embed-url).","type":"string"},"Amount":{"description":"The amount to send to the customer's debit card.","type":"number"},"Currency":{"description":"3 character currency code for the currency to sent to the customer's debit card. If this is not specified the transaction will use the account's local currency (CAD).","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"}},"required":["AccountID","Key","Signature","CardToken","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/debit-card/aft/transaction":{"get":{"description":"This method is used to look up and return the full details on a single AFT transaction. AFT transactions pull money from you debit card directly into your VoPay account .","summary":"debit-card/aft/transaction","tags":["Debit Card Endpoints"],"operationId":"AFTPullFundsTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: successful, failed, rejected","example":"successful"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the transaction. This is the amount that was sent to the customer's debit card.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"PushToCardToken":{"type":"string","description":"A unique token who has the card information. Note. For security purposes we do not store the customer debit card information.","example":"ACBDF-GAFSHD-AHBS-123456"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code.","example":"CA"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes.","example":"2023-11-03 01:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","PushToCardToken","Country","GLCode","LastModified"]}}}}}}},"/interac/money-request":{"post":{"description":"This API endpoint is used to create a new Interac money request transaction.\n\n If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the transaction.","summary":"interac/money-request","tags":["Interac Endpoints"],"operationId":"InteracMoneyRequestPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"PhoneNumber":{"description":"Customer's phone number. (Digits only - no parentheses or dashes allowed.)","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"Province":{"description":"Customer's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"PostalCode":{"description":"Customer's postal code.","type":"string"},"Amount":{"description":"The amount to debit from the customer's bank account.","type":"number"},"Currency":{"description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency (generally CAD).  NOTE: Currently the eft/fund API endpoint only supports CAD transactions.","type":"string"},"EmailAddress":{"description":"Email address the interac money request transaction was sent to.","type":"string"},"RecipientName":{"description":"The money transfer recipient's name","type":"string"},"MessageForRecipient":{"description":"An optional message set by client for the recipient","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number which was associated with the transaction. This can only be used to look up the transaction if it was a unique ID.","type":"string"},"GenerateURL":{"description":"Generate a URL for the money request instead of sending an e-mail.","type":"boolean"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","Amount","Currency","EmailAddress","RecipientName"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: requested, pending, successful, failed, cancelled","example":"pending"},"Flagged":{"type":"string","description":"Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.","example":"The transaction has been flagged as a potential duplicate.","x-absent-when":"transaction not flagged"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus"]}}}}}}},"/interac/money-request/transaction/request-cancellation":{"post":{"description":"This endpoint allows you to attempt to cancel an in progress money request transaction. Note that the cancellation request will fail if the recipient has already fulfilled the request. A successful cancellation using this endpoint will incur an Interac network cancellation fee.","summary":"interac/money-request/transaction/request-cancellation","tags":["Interac Endpoints"],"operationId":"InteracMoneyRequestTransactionsCancelPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/InteracMoneyRequestTransactionsCancelPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status - cancellation requested","example":"cancellation requested"},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp when the transaction status was last modified","example":"2019-11-26 12:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/interac/money-request/transaction":{"get":{"description":"This endpoint is used to look up details on a single Interac money request transaction. This endpoint can be used to return transactions created with the API, or transactions submitted via SFTP batch file.","summary":"interac/money-request/transaction","tags":["Interac Endpoints"],"operationId":"InteracMoneyRequestTransactionGet","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":"TransactionID","in":"query","required":false,"description":"Unique ID of the withdraw transaction. Either this or ClientReferenceNumber is required.","schema":{"type":"integer","format":"int32"}},{"name":"ClientReferenceNumber","in":"query","required":false,"description":"An optional reference number which was associated with the transaction. This can only be used to look up the transaction if it was a unique ID.","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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: requested, pending, successful, failed, cancelled.","example":"pending"},"FailureReason":{"type":"string","description":"A message in case of transaction failure indicating why it failed.","example":"{Reason}"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was received","example":"2019-11-02 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the fund transaction. This is the amount that was withdrawn from the customer's bank account.","example":"2000.00"},"Currency":{"type":"string","description":"The currency for the transaction( generally CAD).","example":"CAD"},"HoldAmount":{"type":"number","description":"Indicates if any of the funds that were credited to your account are still being held.","example":"2000.00"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-12 01:00:00"},"BatchFileName":{"type":"string","description":"The filename for the batch that the request was submitted in, if the transaction was created as part of a CSV batch.","example":"BMO_112567"},"Name":{"type":"string","description":"Customer's name","example":"John Doe"},"Email":{"type":"string","description":"Email address the interac money request transaction was sent to.","example":"johndoe@email.com"},"PhoneNumber":{"type":"string","description":"Customer's phone number","example":"6041235678"},"RecipientName":{"type":"string","description":"The money transfer recipient's name","example":"John Doe"},"MessageForRecipient":{"type":"string","description":"An optional message set by client for the recipient","example":"Message"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction. This can only be used to look up the transaction if it was a unique ID.","example":""},"ConfirmationNumber":{"type":"string","description":"The bank confirmation number for the interac transaction.","example":"112233"},"ProcessingDate":{"type":"string","format":"date-time","description":"The timestamp when the transaction was processed and the money request email was sent.","example":"2019-11-19 12:00:00"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"MoneyRequestURL":{"type":"string","description":"Interac Money Request URL.","example":""}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","FailureReason","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","BatchFileName","Name","Email","PhoneNumber","RecipientName","MessageForRecipient","ClientReferenceNumber","ConfirmationNumber","ProcessingDate","GLCode","TransactionTypeCode","MoneyRequestURL"]}}}}}}},"/interac/bulk-payout":{"post":{"description":"This endpoint is used to create an Interac e-Transfer bulk payout transaction for sending funds.\n\n If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the transaction.","summary":"interac/bulk-payout","tags":["Interac Endpoints"],"operationId":"InteracBulkPayoutPost","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 e-transfer","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"Amount":{"description":"The amount to debit from the customer's bank account.","type":"number"},"Currency":{"description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency (generally CAD).  NOTE: Currently the eft/fund API endpoint only supports CAD transactions.","type":"string"},"EmailAddress":{"description":"Recipient's email address. Either EmailAddress or PhoneNumber must be provided","type":"string"},"PhoneNumber":{"description":"Recipient's mobile phone number. (Digits only - no parentheses or dashes allowed.). Either EmailAddress or PhoneNumber must be provided","type":"string"},"SenderName":{"description":"Sender's full name. This is the name that will be used as the sender's name in the notifications to the recipient. If not provided, your VoPay account name will be used.","type":"string"},"RecipientName":{"description":"Recipient's name, as known by the sender.","type":"string"},"Address1":{"description":"Recipient's address line 1","type":"string"},"Address2":{"description":"Recipient's address line 2","type":"string"},"City":{"description":"Recipient's city","type":"string"},"Province":{"description":"Recipient's province specified using two character abbreviations (eg. BC, AB)","type":"string"},"Country":{"description":"Recipient's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"PostalCode":{"description":"Recipient's postal code.","type":"string"},"Language":{"description":"Recipient's language preference. Accepted values: en (English as the default) or fr (French).","type":"string"},"CancellationPeriod":{"description":"1-30 , number of days after which the transfer will be marked as cancelled.","type":"integer"},"Memo":{"description":"Message to recipient. Set by client for the recipient.","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number which was associated with the transaction.","type":"string"},"Question":{"description":"Security question for the transaction.","type":"string"},"Answer":{"description":"Answer to the security question. This can be either a plain text answer or a hashed answer. Hashed answers must have leading and trailing whitespace trimmed, be SHA2 hashed and Base64 encoded. If a hashed answer is provided, the HashSalt input is mandatory.","type":"string"},"HashSalt":{"description":"The salt used to hash the answer. This input is mandatory if a hashed answer is provided.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","Amount","RecipientName","Question","Answer"]}}},"required":true},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the sending was successful, false if it failed","example":true},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: requested, pending, in progress, successful, failed, cancelled","example":"successful"},"Flagged":{"type":"string","description":"Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.","example":"The transaction has been flagged as a potential duplicate.","x-absent-when":"transaction not flagged"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus"]}}}}}}},"/interac/bulk-payout/transaction/request-cancellation":{"post":{"description":"This endpoint allows you to attempt to cancel an in progress bulk payout transaction. Note that the cancellation request will fail if the recipient has already deposited the funds, and successful cancellation using this endpoint will incur an Interac network cancellation fee.","summary":"interac/bulk-payout/transaction/request-cancellation","tags":["Interac Endpoints"],"operationId":"InteracTransactionsCancelPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/InteracMoneyRequestTransactionsCancelPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status - cancellation requested","example":"cancellation requested"},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp when the transaction status was last modified","example":"2019-11-26 12:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/interac/bulk-payout/transaction":{"get":{"description":"This endpoint is used to look up details on an Interac e-Transfer bulk payout transaction.","summary":"interac/bulk-payout/transaction","tags":["Interac Endpoints"],"operationId":"InteracBulkPayoutTransactionGet","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 e-transfer","schema":{"type":"string"}},{"name":"ClientReferenceNumber","in":"query","required":false,"description":"An optional reference number which was associated with the transaction.","schema":{"type":"string"}},{"name":"TransactionID","in":"query","required":false,"description":"Unique ID of the fund transaction. Either this or ClientReferenceNumber is required.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the e-transfer was successful, false if it failed.","example":true},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction.","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: requested, pending, in progress, successful, failed, cancelled.","example":"pending"},"FailureReason":{"type":"string","description":"A message in case of transaction failure indicating why it failed.","example":""},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was received.","example":"2019-11-02 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the transaction.","example":"2000.00"},"Currency":{"type":"string","description":"3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency (generally CAD).  NOTE: Currently the eft/fund API endpoint only supports CAD transactions.","example":"CAD"},"HoldAmount":{"type":"number","description":"Indicates if any of the funds from the transaction are still being held.","example":"2000.00"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified.","example":"2019-11-12 12:00:00"},"SenderName":{"type":"string","description":"Sender's full name. This is the name that will be used as the sender's name in the notifications to the recipient.","example":"John Doe"},"RecipientName":{"type":"string","description":"Recipient's name, as known by the sender.","example":"Max Doe"},"EmailAddress":{"type":"string","description":"Recipient's email address.","example":"maxdoe@email.com"},"Memo":{"type":"string","description":"Message to recipient.","example":""},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"ConfirmationNumber":{"type":"string","description":"The bank confirmation number for the Interac transaction.","example":"11223344"},"ProcessingDate":{"type":"string","format":"date-time","description":"The timestamp when the transaction was processed and the e-transfer email was sent.","example":"2019-12-01 12:00:00"},"CancellationPeriod":{"type":"integer","description":"The number of days after which the transfer will be marked as cancelled.","example":"2"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","FailureReason","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","SenderName","RecipientName","EmailAddress","Memo","ClientReferenceNumber","ConfirmationNumber","ProcessingDate","CancellationPeriod","GLCode","TransactionTypeCode"]}}}}}}},"/interac/inbound/transaction":{"get":{"description":"This endpoint is used to look up details of Inbound ETransfer transactions.","summary":"interac/inbound/transaction","tags":["Interac Endpoints"],"operationId":"InteracInboundETransfersGET","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":"TransactionID","in":"query","required":false,"description":"Unique ID of the Inbound E transaction.","schema":{"type":"integer","format":"int32"}}],"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":""},"Transactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of Inbound ETransfer Transaction","properties":{"0":{"type":"object","properties":{"ID":{"type":"integer","description":"The unique ID of the transaction.","example":"1234"},"MessageID":{"type":"string","description":"Unique ID of the Inbound ETransfer recived","example":"1772b6ea650423asd"},"Name":{"type":"string","description":"Sender's FullName","example":"John Doe"},"Amount":{"type":"number","description":"The dollar amount of the inbound etransfer transaction. This is the amount that was withdrawn from the customer's bank account.","example":"2000.00"},"Status":{"type":"string","description":"A message indicating the current transaction status.","example":"successful"},"Message":{"type":"string","description":"Contains a description of the message sent in the inbound etransfer","example":""},"DateReceived":{"type":"string","format":"date-time","description":"The timestamp when the transaction was received.","example":"2019-11-19 12:00:00"}},"required":["ID","MessageID","Name","Amount","Status","Message","DateReceived"]}},"x-empty-when":"no inbound transactions match","x-list-of":"inline"}},"required":["Success","ErrorMessage","Transactions"]}}}}}}},"/rtr/withdraw":{"post":{"description":"This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. \n\n Either an iq11 Token or FinancialInstitutionNumber/BranchTransitNumber/AccountNumber is required. \n\n If a ClientAccountID is provided, the client account's first/last name and default bank account will be used for the transaction.","summary":"rtr/withdraw","tags":["Vopay Instant Endpoints"],"operationId":"RtrWithdrawPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Recipient's first name","type":"string"},"LastName":{"description":"Recipient's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"AccountNumber":{"description":"Recipient's bank account number. This is the account that funds will be deposited into.","type":"string"},"FinancialInstitutionNumber":{"description":"Canadian banks. Three digit institution number.","type":"string"},"BranchTransitNumber":{"description":"Canadian banks. Transit number for the Recipient's account.","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"Amount":{"description":"The amount in the specified currency to deposit into the recipient's bank account.","type":"number"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transaction.","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","AccountNumber","FinancialInstitutionNumber","BranchTransitNumber","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"},"TransactionStatus":{"type":"string","description":"The current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"Flagged":{"type":"string","description":"Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.","example":"The transaction has been flagged as a potential duplicate.","x-absent-when":"transaction not flagged"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus"]}}}}}}},"/rtr/withdraw/transaction/request-cancellation":{"post":{"description":"This endpoint allows you to attempt to cancel an in progress Vopay Instant transaction. Note that the cancellation request will fail if the recipient has already deposited the funds.","summary":"rtr/withdraw/transaction/request-cancellation","tags":["Vopay Instant Endpoints"],"operationId":"RTRTransactionsCancelPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/InteracMoneyRequestTransactionsCancelPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status - cancellation requested","example":"cancellation requested"},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp when the transaction status was last modified","example":"2022-11-26 12:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/rtr/withdraw/transaction":{"get":{"description":"This endpoint is used to look up details on a single VoPay Instant withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account.","summary":"rtr/withdraw/transaction","tags":["Vopay Instant Endpoints"],"operationId":"RtrWithdrawTransactionGet","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":"TransactionID","in":"query","required":false,"description":"Unique ID of the withdraw transaction. Must provide either a TransactionID or ClientReferenceNumber.","schema":{"type":"integer","format":"int32"}},{"name":"ClientReferenceNumber","in":"query","required":false,"description":"A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.","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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"RecipientName":{"type":"string","description":"Recipient's name","example":"VoPay"},"FinancialInstitutionNumber":{"type":"string","description":"Three digit institution number for a Canadian bank.","example":"112"},"BranchTransitNumber":{"type":"string","description":"Transit number for the customer's account.","example":"11809"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"227654387"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"ProcessingDate":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was processed..","example":"2019-11-03 01:00:00"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified.","example":"2019-11-03 01:00:00"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","RecipientName","FinancialInstitutionNumber","BranchTransitNumber","AccountNumber","ClientReferenceNumber","ProcessingDate","GLCode","LastModified","TransactionTypeCode"]}}}}}}},"/ach/fund":{"post":{"description":"This endpoint is used to fund your US VoPay account by debiting funds from the specified customer's bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.\n\n If a ClientAccountID is provided, the client account's first/last name, address, phone number, identification number and default bank account will be used for the transaction.","summary":"ach/fund","tags":["ACH Endpoints"],"operationId":"ACHFundPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"IdentificationNumber":{"description":"For individuals, a driver's license, SSN or Passport can be provided. For companies, a federal tax ID is required.","type":"string"},"EmailAddress":{"description":"Customer's email address","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"ZipCode":{"description":"Customer's zip code.","type":"string"},"IPAddress":{"description":"Customer's IP address.","type":"string"},"ABARoutingNumber":{"description":"ABA routing transit number for customer's US bank account.","type":"integer"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"integer"},"Amount":{"description":"The amount to debit from the customer's bank account.","type":"number"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"PlaidProcessorToken":{"description":"Used by clients with a Plaid account. When this is provided, the routing number and account number are not required.","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ClientReferenceNumber":{"description":"A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"},"SecCode":{"description":"The ACH Standard Entry Class (SEC) code. Defaults to PPD if not specified.","type":"string"},"TransactionLabel":{"description":"TransactionLabel overrides originator short name","type":"string"},"WalletID":{"description":"The ID of the wallet to associate with the transaction. Requires ClientAccountID to be provided.","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","CompanyName","IdentificationNumber","EmailAddress","PhoneNumber","Address1","City","State","Country","ZipCode","ABARoutingNumber","AccountNumber","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/ach/withdraw":{"post":{"description":"This endpoint is used to send funds to a specified customer's US Bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.\n\n If a ClientAccountID is provided, the client account's first/last name, address, phone number, identification number and default bank account will be used for the transaction.","summary":"ach/withdraw","tags":["ACH Endpoints"],"operationId":"ACHWithdrawPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"IdentificationNumber":{"description":"Customer's driver's licence (individuals) or federal tax ID (companies).","type":"string"},"EmailAddress":{"description":"Customer's email address","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"ZipCode":{"description":"Customer's zip code.","type":"string"},"IPAddress":{"description":"Customer's IP address.","type":"string"},"ABARoutingNumber":{"description":"ABA routing transit number for customer's US bank account.","type":"integer"},"AccountNumber":{"description":"Account number for the customer's US bank account","type":"integer"},"Amount":{"description":"The amount to credit to the customer's bank account.","type":"number"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"PlaidProcessorToken":{"description":"Used by clients with a Plaid account. When this is provided, the routing number and account number are not required.","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ClientReferenceNumber":{"description":"A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"},"SecCode":{"description":"The ACH Standard Entry Class (SEC) code. Defaults to PPD if not specified.","type":"string"},"TransactionLabel":{"description":"TransactionLabel overrides originator short name","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","CompanyName","IdentificationNumber","EmailAddress","PhoneNumber","Address1","City","State","Country","ZipCode","ABARoutingNumber","AccountNumber","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/ach/fund/schedule":{"post":{"description":"This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. \n\nEither CompanyName OR FirstName and LastName must be provided. \n\n If the Token is provided, the ABARoutingNumber, and AccountNumber will not be required. \n\n If the bank information is provided (ABARoutingNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.\n\n If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.\n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment.","summary":"ach/fund/schedule","tags":["ACH Endpoints"],"operationId":"ACHFundSchedulePOST","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","type":"string"},"Amount":{"description":"The amount to schedule in the transactions","type":"number"},"Frequency":{"description":"The frequency of the scheduled transaction: single or recurring.","type":"string"},"NameOfFrequency":{"description":"Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly.","type":"string"},"ScheduleStartDate":{"description":"Date from which the schedule will be started","type":"string"},"ScheduleEndDate":{"description":"Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"string"},"EndingAfterPayments":{"description":"Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"integer"},"SemiMonthlyFrequencyType":{"description":"Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast","type":"integer"},"Description":{"description":"Description of the schedule transaction","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"IdentificationNumber":{"description":"Customer's driver's licence (individuals) or federal tax ID (companies).","type":"string"},"EmailAddress":{"description":"Customer's email address","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"ZipCode":{"description":"Customer's zip code.","type":"string"},"IPAddress":{"description":"Customer's IP address.","type":"string"},"ABARoutingNumber":{"description":"ABA routing transit number for customer's US bank account.","type":"integer"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request. ","type":"string"}},"required":["AccountID","Key","Signature","Amount","Frequency","NameOfFrequency","ScheduleStartDate","ScheduleEndDate","EndingAfterPayments","Description","FirstName","LastName","CompanyName","IdentificationNumber","EmailAddress","PhoneNumber","Address1","City","State","Country","ZipCode","ABARoutingNumber","AccountNumber"]}}},"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":""},"Amount":{"type":"number","description":"The dollar amount of the schedule transaction","example":"200.00"},"ScheduledTransactionID":{"type":"integer","description":"ID of the schedule Transaction.","example":"1122"},"Frequency":{"type":"string","description":"The frequency of the transaction","example":"single"},"Description":{"type":"string","description":"Description of the schedule transaction","example":""},"ScheduleStartDate":{"type":"string","format":"date","description":"Date from which the transaction will be started ","example":"2020-01-01"},"Status":{"type":"string","description":"A message indicating the current transaction status. Statuses are: cancelled, completed or in progress","example":"in progress"}},"required":["Success","ErrorMessage","Amount","ScheduledTransactionID","Frequency","Description","ScheduleStartDate","Status"]}}}}}}},"/ach/withdraw/schedule":{"post":{"description":"This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. \n\nEither CompanyName OR FirstName and LastName must be provided. \n\n If the Token is provided, the ABARoutingNumber, and AccountNumber will not be required. \n\n If the bank information is provided (ABARoutingNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.\n\n If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.\n\nFor additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment.","summary":"ach/withdraw/schedule","tags":["ACH Endpoints"],"operationId":"ACHWithdrawSchedulePOST","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","type":"string"},"Amount":{"description":"The amount to schedule in the transactions","type":"number"},"Frequency":{"description":"The frequency of the scheduled transaction: single or recurring.","type":"string"},"NameOfFrequency":{"description":"Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly.","type":"string"},"ScheduleStartDate":{"description":"Date from which the schedule will be started","type":"string"},"ScheduleEndDate":{"description":"Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"string"},"EndingAfterPayments":{"description":"Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments","type":"integer"},"SemiMonthlyFrequencyType":{"description":"Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast","type":"integer"},"Description":{"description":"Description of the schedule transaction","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"IdentificationNumber":{"description":"Customer's driver's licence (individuals) or federal tax ID (companies).","type":"string"},"EmailAddress":{"description":"Customer's email address","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"ZipCode":{"description":"Customer's zip code.","type":"string"},"IPAddress":{"description":"Customer's IP address.","type":"string"},"ABARoutingNumber":{"description":"ABA routing transit number for customer's US bank account.","type":"integer"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"}},"required":["AccountID","Key","Signature","Amount","Frequency","NameOfFrequency","ScheduleStartDate","ScheduleEndDate","EndingAfterPayments","Description","FirstName","LastName","CompanyName","IdentificationNumber","EmailAddress","PhoneNumber","Address1","City","State","Country","ZipCode","ABARoutingNumber","AccountNumber"]}}},"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":""},"Amount":{"type":"number","description":"The dollar amount of the schedule transaction","example":"200.00"},"ScheduledTransactionID":{"type":"integer","description":"ID of the schedule Transaction.","example":"1122"},"Frequency":{"type":"string","description":"The frequency of the transaction","example":"single"},"Description":{"type":"string","description":"Description of the schedule transaction","example":""},"ScheduleStartDate":{"type":"string","format":"date","description":"Date from which the transaction will be started ","example":"2020-01-01"},"Status":{"type":"string","description":"A message indicating the current transaction status. Statuses are: cancelled, completed or in progress","example":"in progress"}},"required":["Success","ErrorMessage","Amount","ScheduledTransactionID","Frequency","Description","ScheduleStartDate","Status"]}}}}}}},"/ach/void":{"post":{"description":"This method is used to void a previously created ACH transaction. Note, you can only void a transaction if it has not yet settled. If the transaction has already settled, then you can use the /ach/refund endpoint to reverse the transaction.","summary":"ach/void","tags":["ACH Endpoints"],"operationId":"ACHVoidPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/CreditCardVoidPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the void transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status - cancelled","example":"cancelled"},"Timestamp":{"type":"string","description":"The timestamp when the transaction status was last modified","example":"2022-02-04 12:34:56"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/ach/fund/transaction":{"get":{"description":"This endpoint is used to look up and return the full details on a single ACH fund transaction.","summary":"ach/fund/transaction","tags":["ACH Endpoints"],"operationId":"AchFundTransactionGet","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":"TransactionID","in":"query","required":true,"description":"The unique ID of the fund transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"HoldReleaseDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction hold release will be released","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the fund transaction. This is the amount that was withdrawn from the customer's bank account.","example":"1200"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"HoldAmount":{"type":"number","description":"Indicates if any of the funds that were credited to your account are still being held.","example":"1200"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-02 01:00:21"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Customer's first name","example":"John"},"LastName*":{"type":"string","description":"Customer's last name","example":"Doe"},"Address1":{"type":"string","description":"Customer's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Customer's address line 2","example":""},"City":{"type":"string","description":"Customer's city","example":"Vancouver"},"Province/State":{"type":"string","description":"Customer's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code","example":"Canada"},"PostalCode/Zipcode":{"type":"string","description":"Customer's postal code.","example":"V4W 5Z7"},"AccountNumber":{"type":"string","description":"Customer's bank account number that funds were debited from.","example":"1100456342"},"ABARoutingNumber":{"type":"string","description":"Routing number for the customer's account.","example":"129320349"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":"876432"},"ScheduledTransactionID":{"type":"integer","description":"Id of the scheduled transaction. This field only will be displayed if the scheduled transaction exists.","example":"1"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","HoldReleaseDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName*","Address1","Address2","City","Province/State","Country","PostalCode/Zipcode","AccountNumber","ABARoutingNumber","ClientReferenceNumber","ScheduledTransactionID","GLCode","TransactionTypeCode"]}}}}}}},"/ach/withdraw/transaction":{"get":{"description":"This endpoint is used to look up details on a single ACH withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's bank account.","summary":"ach/withdraw/transaction","tags":["ACH Endpoints"],"operationId":"AchWithdrawTransactionGet","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":"TransactionID","in":"query","required":true,"description":"Unique ID of the withdraw transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"USD"},"HoldAmount":{"type":"number","description":"Will always be 0 for withdraw transactions, however parameter is included to keep return data format consistent with the format used for fund transactions.","example":"2000"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances withdraw transaction record will not be modified.","example":"2019-11-03 01:00:00"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Recipient's first name","example":"John"},"LastName":{"type":"string","description":"Recipient's last name","example":"Doe"},"PhoneNumber":{"type":"integer","description":"Recipient's phone number","example":"604556****"},"Address1":{"type":"string","description":"Recipient's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Recipient's address line 2","example":""},"City":{"type":"string","description":"Recipient's city","example":"Los Angeles"},"Province/State":{"type":"string","description":"Recipient's province or state specified using two character abbreviation (eg. BC, AB)","example":"CA"},"Country":{"type":"string","description":"Recipient's country specified using full country name.","example":"USA"},"PostalCode/ZipCode":{"type":"string","description":"Recipient's postal or zip code.","example":"90210"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"227654387"},"ABARoutingNumber":{"type":"string","description":"Routing number for the customer's account.","example":"129320349"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName","PhoneNumber","Address1","Address2","City","Province/State","Country","PostalCode/ZipCode","AccountNumber","ABARoutingNumber","ClientReferenceNumber","GLCode","TransactionTypeCode"]}}}}}}},"/ach/scheduled-transactions":{"get":{"description":"This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction. \n\n If the value ScheduledTransactionID is present, we only list the details of that scheduled transaction.  \n\n * Either the response will be Company name or First name and Last name","summary":"ach/scheduled-transactions","tags":["ACH Endpoints"],"operationId":"AchScheduledTransactionGet","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":"ScheduledTransactionID","in":"query","required":true,"description":"ID of the schedule Transaction (If this value is present, we list the details of the scheduled transactions)","schema":{"type":"integer","format":"int32"}},{"name":"ClientAccountID","in":"query","required":false,"description":"Client Account ID","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":""},"NumberOfRecords":{"type":"number","description":"Total number of the scheduled transaction records returned","example":"1"},"ScheduledTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of scheduled Transaction info data","properties":{"0":{"type":"object","properties":{"ID":{"type":"integer","description":"Unique ID for the scheduled transaction","example":"15"},"Type":{"type":"string","description":"The payment type of scheduled transaction; i.e., funding or withdraw","example":"funding"},"Amount":{"type":"number","description":"The amount of the scheduled transaction","example":"25.00"},"Frequency":{"type":"string","description":"The frequency of the schedule: single or recurring","example":"recurring"},"Description":{"type":"string","description":"Description of the scheduled transaction","example":"Scheduled transaction 1234"},"Notes":{"type":"string","description":"Note that will be attached to each scheduled transaction","example":"Loan repayment 1234"},"NameOfFrequency":{"type":"string","description":"Name of the frequency of the transaction: weekly, biweekly, monthly, bimonthly, 3 months, 6 months, yearly. Only provided if Frequency provided is recurring.","example":"weekly"},"Status":{"type":"string","description":"A message indicating the current transaction status. Statuses are: cancelled, completed, or in progress","example":"in progress"},"StartDate":{"type":"string","format":"date","description":"Date from which the transaction will be started","example":"2020-01-01"},"EndDate":{"type":"string","format":"date","description":"Date from which the transaction will end","example":"2021-01-01"},"EndingAfterPayments":{"type":"integer","description":"Number of payments after which the transaction processing will end","example":"12"},"ScheduledDetails":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction","properties":{"0":{"type":"object","properties":{"Token":{"type":"string","description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints","example":"ACBDF-GAFSHD-AHBS-123456"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"*****387"},"ABARoutingNumber":{"type":"string","description":"ABA routing transit number for customer's US bank account.","example":"1123****"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Customer's first name","example":"John"},"LastName*":{"type":"string","description":"Customer's last name","example":"Doe"},"Address1":{"type":"string","description":"Recipient's address line 1","example":"112 Bentall Street"},"City":{"type":"string","description":"Recipient's city","example":"Vancouver"},"ZipCode":{"type":"string","description":"Recipient's zip code.","example":"V2W 4V6"},"State":{"type":"string","description":"Recipient's state specified using two character abbreviations (eg. CA, AZ","example":"CA"},"Country":{"type":"string","description":"Recipient's country specified using full country name.","example":"Canada"},"IPAddress":{"type":"string","description":"Recipient's IP address.","example":"127.0.0.1"},"PhoneNumber":{"type":"integer","description":"Recipient's phone number","example":"604556****"},"IdentificationNumber":{"type":"string","description":"Customer's driver's licence (individuals) or federal tax ID (companies).","example":""},"ErrorMessage":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction payments, this is the log of the failures","properties":{"0":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":false},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""}},"required":["Success","ErrorMessage"]}},"x-list-of":"inline","x-empty-when":"no items"}},"required":["Token","AccountNumber","ABARoutingNumber","CompanyName*","FirstName*","LastName*","Address1","City","ZipCode","State","Country","IPAddress","PhoneNumber","IdentificationNumber","ErrorMessage"]}},"x-list-of":"inline","x-empty-when":"no items"},"UpcomingTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Upcoming transaction listing (This option only will be available if the user provides ScheduledTransactionID as a parameter)","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"ID of the eft transaction (Empty because it is a future payment)","example":""},"ScheduledDate":{"type":"string","format":"date","description":"Date from which the payment will start","example":"2020-01-01"},"ProcessingDate":{"type":"string","format":"date","description":"Date where this payment was processed (Empty because it is a future payment)","example":""},"LastModified":{"type":"string","format":"date","description":"Date of the last modification of this payment (Empty because it is a future payment)","example":""},"Status":{"type":"string","description":"Status of the upcoming payment (Empty because it is a future payment)","example":""},"Amount":{"type":"number","description":"The amount of the scheduled transaction","example":"10.00"}},"required":["TransactionID","ScheduledDate","ProcessingDate","LastModified","Status","Amount"]}},"x-list-of":"inline","x-empty-when":"no items"},"CompletedTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... List of the completed transactions (This option only will be available if the user provides ScheduledTransactionID as a parameter)","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"ID of the EFT transaction","example":"1"},"ScheduledDate":{"type":"string","format":"date","description":"Date from which the transaction will start","example":"2020-01-01"},"ProcessingDate":{"type":"string","format":"date","description":"Date where this transaction was processed","example":"2020-01-02"},"LastModified":{"type":"string","format":"date","description":"Date of the last modification of this transaction","example":"2020-01-02"},"Status":{"type":"string","description":"Status of the transaction","example":"pending"},"Amount":{"type":"number","description":"The amount of the transaction","example":"10.00"}},"required":["TransactionID","ScheduledDate","ProcessingDate","LastModified","Status","Amount"]}},"x-list-of":"inline","x-empty-when":"no items"}},"required":["ID","Type","Amount","Frequency","Description","Notes","NameOfFrequency","Status","StartDate","EndDate","EndingAfterPayments","ScheduledDetails","UpcomingTransactions","CompletedTransactions"]}},"x-empty-when":"no scheduled transactions match","x-list-of":"inline"}},"required":["Success","ErrorMessage","NumberOfRecords","ScheduledTransactions"]}}}}}}},"/ach/failures":{"get":{"description":"This endpoint is used to retrieve a list of transactions which failed during a specific date range. This endpoint is queried based on the date that a failure occurred on, not on the date when the transaction originally occurred.","summary":"ach/failures","tags":["ACH Endpoints"],"operationId":"AchFailuresGet","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":"StartDateTime","in":"query","required":true,"description":"Start of date range to query for any failed transactions","schema":{"type":"string","format":"date-time"}},{"name":"EndDateTime","in":"query","required":true,"description":"End of date range to query for any failed transactions","schema":{"type":"string","format":"date-time"}}],"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":""},"NumberOfRecords":{"type":"number","description":"Total number of failed transaction records returned","example":"1"},"FailedTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of TransactionInfo data","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"Unique ID for the Transaction","example":"5918"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp on which the transaction occurred.","example":"2019-12-04 18:13:39"},"TransactionType":{"type":"string","description":"Specifies the type of transaction, for example 'ACH Funding', 'ACH Withdrawal'.","example":"ACH Funding"},"DollarAmount":{"type":"number","description":"The dollar amount of the failed transaction.","example":"25.00"},"ErrorCode":{"type":"string","description":"Detail error code of the failure.","example":"R01"},"FailureReason":{"type":"string","description":"Detailed description of why the transaction failed. Transactions which have failed cannot be modified, a new fund or withdraw transaction must be created if you wish to re-attempt the transaction.","example":"insufficient funds"},"ClientReferenceNumber":{"type":"string","description":"The optional reference number which was set when the transaction was created.","example":"null"}},"required":["TransactionID","TransactionDateTime","TransactionType","DollarAmount","ErrorCode","FailureReason","ClientReferenceNumber"]}},"x-empty-when":"no failed transactions match","x-list-of":"inline"}},"required":["Success","ErrorMessage","NumberOfRecords","FailedTransactions"]}}}}}}},"/ach/validate-nacha":{"post":{"description":"This endpoint is used to trigger a NACHA validation on the provided bank account. In the endpoint below, either Token or ABARoutingNumber/AccountNumber are required. Either a CompanyName OR FirstName and LastName must be provided.","summary":"ach/validate-nacha","tags":["ACH Endpoints"],"operationId":"AchValidateNachaPost","deprecated":false,"requestBody":{"content":{"multipart/form-data":{"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"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. This can be provided in lieu of a routing number and account number.","type":"string"},"ABARoutingNumber":{"description":"ABA routing number for customer's US bank account. This can be provided in lieu of a token.","type":"integer"},"AccountNumber":{"description":"Customer's bank account number for transaction code. This can be provided in lieu of a token.","type":"integer"},"CompanyName":{"description":"Company's name. This can be provided in lieu of first name and last name.","type":"string"},"FirstName":{"description":"Customer's first name. This can be provided in lieu of a company name.","type":"string"},"LastName":{"description":"Customer's last name. This can be provided in lieu of a company name.","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address":{"description":"Customer's civic number and street name (eg. 123 Main Street)","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"ZipCode":{"type":"string"}},"required":["AccountID","Key","Signature","Token","ABARoutingNumber","AccountNumber","CompanyName","FirstName","LastName","PhoneNumber","Address","City","State","ZipCode"]}}},"required":true},"responses":{"200":{"description":"Response indicating the result of the NACHA validation.","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":"","example":""},"ValidationResult":{"type":"string","description":"The result of the NACHA validation. Possible values are: verified or failed.","example":"verified"}},"required":["Success","ErrorMessage","ValidationResult"]}}}}}}},"/fedwire/fund":{"post":{"description":"This endpoint is used to fund your US Bank account by debiting funds from the specified customer's bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.\n\n If a ClientAccountID is provided, the client account's first/last name, address, phone number, and default bank account will be used for the transaction.","summary":"fedwire/fund","tags":["Fedwire Endpoints"],"operationId":"FedwireFundPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"EmailAddress":{"description":"Customer's email address","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"ZipCode":{"description":"Customer's zip code.","type":"string"},"IPAddress":{"description":"Customer's IP address.","type":"string"},"ABARoutingNumber":{"description":"ABA routing transit number for customer's US bank account.","type":"integer"},"AccountNumber":{"description":"Customer's bank account number for funds to be debited from.","type":"integer"},"Amount":{"description":"The amount to debit from the customer's bank account.","type":"number"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"},"WalletID":{"description":"The ID of the wallet to associate with the transaction. Requires ClientAccountID to be provided.","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","CompanyName","EmailAddress","PhoneNumber","Address1","City","State","Country","ZipCode","ABARoutingNumber","AccountNumber","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/fedwire/withdraw":{"post":{"description":"This endpoint is used to send funds to a specified customer's US Bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.\n\n If a ClientAccountID is provided, the client account's first/last name, address, phone number, and default bank account will be used for the transaction.","summary":"fedwire/withdraw","tags":["Fedwire Endpoints"],"operationId":"FedwireWithdrawPost","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"FirstName":{"description":"Customer's first name","type":"string"},"LastName":{"description":"Customer's last name","type":"string"},"CompanyName":{"description":"Company's name","type":"string"},"EmailAddress":{"description":"Customer's email address","type":"string"},"PhoneNumber":{"description":"Customer's phone number. Digits only - no parentheses or dashes allowed.","type":"string"},"Address1":{"description":"Customer's address line 1","type":"string"},"Address2":{"description":"Customer's address line 2","type":"string"},"City":{"description":"Customer's city","type":"string"},"State":{"description":"Customer's state specified using two character abbreviations (eg. CA, AZ)","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code.","type":"string"},"ZipCode":{"description":"Customer's zip code.","type":"string"},"IPAddress":{"description":"Customer's IP address.","type":"string"},"ABARoutingNumber":{"description":"ABA routing transit number for customer's US bank account.","type":"integer"},"AccountNumber":{"description":"Account number for the customer's US bank account","type":"integer"},"Amount":{"description":"The amount to credit to the customer's bank account.","type":"number"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","CompanyName","EmailAddress","PhoneNumber","Address1","City","State","Country","ZipCode","ABARoutingNumber","AccountNumber","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"This ID should be saved as it is required in order to look up status information on the transaction.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/fedwire/void":{"post":{"description":"This method is used to void a previously created Fedwire transaction. Note, you can only void a transaction if it has not yet settled. If the transaction has already settled, then you can use the /fedwire/refund endpoint to reverse the transaction.","summary":"fedwire/void","tags":["Fedwire Endpoints"],"operationId":"FedwireVoidPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/CreditCardVoidPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the void transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status - cancelled","example":"cancelled"},"Timestamp":{"type":"string","description":"The timestamp when the transaction status was last modified","example":"2022-02-04 12:34:56"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","Timestamp"]}}}}}}},"/fedwire/refund":{"post":{"description":"This method is used to refund a previously created Fedwire transaction.","summary":"fedwire/refund","tags":["Fedwire Endpoints"],"operationId":"FedwireRefundPost","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"},"TransactionID":{"description":"The unique ID for the transaction you want to refund","type":"integer"},"Amount":{"description":"The amount to refund. Value must be equal to or less than the original transaction amount. If no amount is provided, the full amount from the original transaction is used.","type":"number"}},"required":["AccountID","Key","Signature","TransactionID"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the refund transaction","example":"1124"},"Timestamp":{"type":"string","description":"The timestamp when the transaction status was last modified","example":"2022-02-04 12:34:56"}},"required":["Success","ErrorMessage","TransactionID","Timestamp"]}}}}}}},"/fedwire/fund/transaction":{"get":{"description":"This endpoint is used to look up and return the full details on a single Fedwire fund transaction.","summary":"fedwire/fund/transaction","tags":["Fedwire Endpoints"],"operationId":"FedwireFundTransactionGet","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":"TransactionID","in":"query","required":true,"description":"The unique ID of the fund transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"HoldReleaseDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction hold release will be released","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the fund transaction. This is the amount that was withdrawn from the customer's bank account.","example":"1200"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"HoldAmount":{"type":"number","description":"Indicates if any of the funds that were credited to your account are still being held.","example":"1200"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-02 01:00:21"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Customer's first name","example":"John"},"LastName*":{"type":"string","description":"Customer's last name","example":"Doe"},"Address1":{"type":"string","description":"Customer's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Customer's address line 2","example":""},"City":{"type":"string","description":"Customer's city","example":"Vancouver"},"Province/State":{"type":"string","description":"Customer's province specified using two character abbreviation (eg. BC, AB)","example":"BC"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code","example":"Canada"},"PostalCode/Zipcode":{"type":"string","description":"Customer's postal code.","example":"V4W 5Z7"},"AccountNumber":{"type":"string","description":"Customer's bank account number that funds were debited from.","example":"1100456342"},"ABARoutingNumber":{"type":"string","description":"The ABA Routing number of the customer's bank.","example":"11234312"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":"876432"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","HoldReleaseDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName*","Address1","Address2","City","Province/State","Country","PostalCode/Zipcode","AccountNumber","ABARoutingNumber","ClientReferenceNumber","GLCode","TransactionTypeCode"]}}}}}}},"/fedwire/withdraw/transaction":{"get":{"description":"This endpoint is used to look up details on a single Fedwire withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's bank account.","summary":"fedwire/withdraw/transaction","tags":["Fedwire Endpoints"],"operationId":"FedwireWithdrawTransactionGet","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":"TransactionID","in":"query","required":true,"description":"Unique ID of the withdraw transaction","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"USD"},"HoldAmount":{"type":"number","description":"Will always be 0 for withdraw transactions, however parameter is included to keep return data format consistent with the format used for fund transactions.","example":"2000"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances withdraw transaction record will not be modified.","example":"2019-11-03 01:00:00"},"CompanyName*":{"type":"string","description":"Company's name","example":"VoPay"},"FirstName*":{"type":"string","description":"Recipient's first name","example":"John"},"LastName":{"type":"string","description":"Recipient's last name","example":"Doe"},"PhoneNumber":{"type":"integer","description":"Recipient's phone number","example":"604556****"},"Address1":{"type":"string","description":"Recipient's address line 1","example":"112 Bentall Street"},"Address2":{"type":"string","description":"Recipient's address line 2","example":""},"City":{"type":"string","description":"Recipient's city","example":"Los Angeles"},"Province/State":{"type":"string","description":"Recipient's province or state specified using two character abbreviation (eg. BC, AB)","example":"CA"},"Country":{"type":"string","description":"Recipient's country specified using full country name.","example":"USA"},"PostalCode/ZipCode":{"type":"string","description":"Recipient's postal or zip code.","example":"90210"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"227654387"},"ABARoutingNumber":{"type":"string","description":"Routing number for the customer's account.","example":"129320349"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","HoldAmount","LastModified","CompanyName*","FirstName*","LastName","PhoneNumber","Address1","Address2","City","Province/State","Country","PostalCode/ZipCode","AccountNumber","ABARoutingNumber","ClientReferenceNumber","GLCode","TransactionTypeCode"]}}}}}}},"/rtp/withdraw":{"post":{"description":"This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. \n\n Either an iq11 Token or ABARoutingNumber/AccountNumber is required.\n\n If a ClientAccountID is provided, the client account's first/last name and default bank account will be used for the transaction.","summary":"rtp/withdraw","tags":["RTP Endpoints"],"operationId":"RtpWithdrawPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/RtpWithdrawPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.","example":"112233"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/rtp/withdraw/transaction":{"get":{"description":"This endpoint is used to look up details on a single RTP withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account.","summary":"rtp/withdraw/transaction","tags":["RTP Endpoints"],"operationId":"RtpWithdrawTransactionGet","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":"TransactionID","in":"query","required":true,"description":"Unique ID of the RTP withdraw transaction.","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"RecipientName":{"type":"string","description":"Recipient's name","example":"VoPay"},"ABARoutingNumber":{"type":"string","description":"The ABA Routing number of the customer's bank.","example":"11234312"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"227654387"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified.","example":"2019-11-03 01:00:00"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","RecipientName","ABARoutingNumber","AccountNumber","ClientReferenceNumber","GLCode","LastModified","TransactionTypeCode"]}}}}}}},"/fednow/withdraw":{"post":{"description":"This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. \n\n Either an iq11 Token or ABARoutingNumber/AccountNumber is required.\n\n If a ClientAccountID is provided, the client account's first/last name and default bank account will be used for the transaction.","summary":"fednow/withdraw","tags":["Fednow Endpoints"],"operationId":"FednowWithdrawPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/RtpWithdrawPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.","example":"112233"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/fednow/withdraw/transaction":{"get":{"description":"This endpoint is used to look up details on a single Fednow withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account.","summary":"fednow/withdraw/transaction","tags":["Fednow Endpoints"],"operationId":"FednowWithdrawTransactionGet","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":"TransactionID","in":"query","required":true,"description":"Unique ID of the Fednow withdraw transaction.","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"RecipientName":{"type":"string","description":"Recipient's name","example":"VoPay"},"ABARoutingNumber":{"type":"string","description":"The ABA Routing number of the customer's bank.","example":"11234312"},"AccountNumber":{"type":"string","description":"Recipient's bank account number that funds were deposited to.","example":"227654387"},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":""},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified.","example":"2019-11-03 01:00:00"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","RecipientName","ABARoutingNumber","AccountNumber","ClientReferenceNumber","GLCode","LastModified","TransactionTypeCode"]}}}}}}},"/google-pay/charge":{"post":{"description":"This endpoint is to create a Google Pay transaction to fund your VoPay account, charging the amount specified to the card linked to the provided Google Pay Token.\n\n If a ClientAccountID is provided, the client account's default Google Pay wallet will be used for the transaction.\n\nNote: You must first generate a GooglePayToken using the /google-pay/generate-embed-url endpoint.","summary":"google-pay/charge","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayChargePOST","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transaction. The contacts payment method associated with this transaction type will be used.","type":"string"},"GooglePayToken":{"description":"The token identifying the Google Pay wallet to charge (returned from /google-pay/generate-embed-url).","type":"string"},"Amount":{"description":"The amount to charge from the customer's Google Pay wallet.","type":"number"},"Currency":{"description":"3 character currency code for the currency to be charged to the customer's Google Pay wallet. If this is not specified the transaction will use the account's local currency.","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code. If this is not specified the transaction will use the local country.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","GooglePayToken","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/google-pay/void":{"post":{"description":"This endpoint allows you to void a completed Google Pay transaction.","summary":"google-pay/void","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayVoidPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/CreditCardVoidPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the void transaction","example":"1124"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/google-pay/charge/transaction":{"get":{"description":"This method is used to look up and return the full details on a single Google Pay transaction. Google Pay transactions take money out of the customer's card and deposit them into your VoPay account.","summary":"google-pay/charge/transaction","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayChargeTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: successful, failed, cancelled, settled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the Google Pay transaction. This is the amount that was withdrawn from the customer's card.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"GooglePayToken":{"type":"string","description":"A unique token who has the Google Pay wallet information. Note. For security purposes we do not store the customer credit card information.","example":"ACBDF-GAFSHD-AHBS-123456"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code.","example":"CA"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-03 01:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","GooglePayToken","Country","GLCode","TransactionTypeCode","LastModified"]}}}}}}},"/apple-pay/charge":{"post":{"description":"This endpoint is to create a Apple Pay transaction to fund your VoPay account, charging the amount specified to the card linked to the provided Apple Pay Token.\n\n If a ClientAccountID is provided, the client account's default Apple Pay wallet will be used for the transaction.\n\nNote: You must first generate a ApplePayToken using the /apple-pay/generate-embed-url endpoint.","summary":"apple-pay/charge","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayChargePOST","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transaction. The contacts payment method associated with this transaction type will be used.","type":"string"},"ApplePayToken":{"description":"The token identifying the Apple Pay wallet to charge (returned from /apple-pay/generate-embed-url).","type":"string"},"Amount":{"description":"The amount to charge from the customer's Apple Pay wallet.","type":"number"},"Currency":{"description":"3 character currency code for the currency to be charged to the customer's Apple Pay wallet. If this is not specified the transaction will use the account's local currency.","type":"string"},"Country":{"description":"Customer's country specified using full country name or ISO 3166-1 alpha-2 code. If this is not specified the transaction will use the local country.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","ApplePayToken","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/apple-pay/void":{"post":{"description":"This endpoint allows you to void a completed Apple Pay transaction.","summary":"apple-pay/void","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayVoidPost","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/CreditCardVoidPost"},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the void transaction","example":"1124"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/apple-pay/charge/transaction":{"get":{"description":"This method is used to look up and return the full details on a single Apple Pay transaction. Apple Pay transactions take money out of the customer's card and deposit them into your VoPay account.","summary":"apple-pay/charge/transaction","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayChargeTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: successful, failed, cancelled, settled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the Apple Pay transaction. This is the amount that was withdrawn from the customer's card.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"ApplePayToken":{"type":"string","description":"A unique token who has the Apple Pay wallet information. Note. For security purposes we do not store the customer credit card information.","example":"ACBDF-GAFSHD-AHBS-123456"},"Country":{"type":"string","description":"Customer's Country specified using full country name or ISO 3166-1 alpha-2 code.","example":"CA"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-03 01:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","ApplePayToken","Country","GLCode","TransactionTypeCode","LastModified"]}}}}}}},"/paypal/withdraw":{"post":{"description":"This endpoint is used to send funds from your VoPay account to a PayPal account.\n\n If a ClientAccountID is provided, the client account's default PayPal wallet will be used for the transaction.","summary":"paypal/withdraw","tags":["PayPal Endpoints"],"operationId":"PayPalWithdrawPOST","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transaction. The contacts payment method associated with this transaction type will be used.","type":"string"},"PayPalToken":{"description":"The token identifying the PayPal wallet to send funds to.","type":"string"},"PayPalRecipientType":{"description":"The type of the PayPal wallet you are sending funds to. Valid values are 'EMAIL', 'PHONE', 'PAYPAL_ID'.","type":"string"},"RecipientID":{"description":"The recipient ID (email address, phone number, or PayPal ID) of the PayPal wallet you are sending funds to. This value corresponds with the PayPalRecipientType value in the request.","type":"string"},"RecipientName":{"description":"The full name of the recipient receiving the funds.","type":"string"},"Amount":{"description":"The amount to send to the customers PayPal wallet.","type":"number"},"Currency":{"description":"3 character currency code for the currency to be charged to the customer's PayPal wallet. If this is not specified the transaction will use the account's local currency.","type":"string"},"Notes":{"description":"Optional notes for the transaction.","type":"string"},"ClientReferenceNumber":{"description":"Optional client reference number for the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","RecipientName","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/paypal/withdraw/transaction":{"get":{"description":"This endpoint is used to look up and return the full details on a single PayPal withdraw transaction. PayPal withdraw send funds from your VoPay account to the customer's PayPal account.","summary":"paypal/withdraw/transaction","tags":["PayPal Endpoints"],"operationId":"PayPalWithdrawTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the PayPal withdraw transaction. This is the amount that was sent to the customer's PayPal account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"PayPalToken":{"type":"string","description":"A unique token of the PayPal recipient information.","example":"ACBDF-GAFSHD-AHBS-123456"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-03 01:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","PayPalToken","GLCode","TransactionTypeCode","LastModified"]}}}}}}},"/venmo/withdraw":{"post":{"description":"This endpoint is used to send funds from your VoPay account to a Venmo account.\n\n If a ClientAccountID is provided, the client account's default Venmo wallet will be used for the transaction.","summary":"venmo/withdraw","tags":["Venmo Endpoints"],"operationId":"VenmoWithdrawPOST","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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transaction. The contacts payment method associated with this transaction type will be used.","type":"string"},"VenmoToken":{"description":"The token identifying the Venmo wallet to send funds to.","type":"string"},"VenmoRecipientType":{"description":"The type of the Venmo wallet you are sending funds to. Valid values are 'EMAIL', 'PHONE', 'USER_HANDLE'.","type":"string"},"RecipientID":{"description":"The recipient ID (email address, phone number, or Venmo user handle) of the Venmo wallet you are sending funds to. This value corresponds with the VenmoRecipientType value in the request.","type":"string"},"RecipientName":{"description":"The full name of the recipient receiving the funds.","type":"string"},"Amount":{"description":"The amount to send to the customers Venmo wallet.","type":"number"},"Notes":{"description":"Optional notes for the transaction.","type":"string"},"ClientReferenceNumber":{"description":"Optional client reference number for the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","RecipientName","Amount"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction that was just submitted.","example":"1122"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/venmo/withdraw/transaction":{"get":{"description":"This endpoint is used to look up and return the full details on a single Venmo withdraw transaction. Venmo withdraw send funds from your VoPay account to the customer's Venmo account.","summary":"venmo/withdraw/transaction","tags":["Venmo Endpoints"],"operationId":"VenmoWithdrawTransactionsGET","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":"TransactionID","in":"query","required":true,"description":"Account transaction ID","schema":{"type":"integer","format":"int32"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID of the transaction","example":"1122"},"TransactionStatus":{"type":"string","description":"A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The timestamp when the transaction was created","example":"2019-11-01 12:00:00"},"Amount":{"type":"number","description":"The dollar amount of the Venmo withdraw transaction. This is the amount that was sent to the customer's Venmo account.","example":"2000"},"Currency":{"type":"string","description":"The currency for the transaction.","example":"CAD"},"VenmoToken":{"type":"string","description":"A unique token of the Venmo recipient information.","example":"ACBDF-GAFSHD-AHBS-123456"},"GLCode":{"type":"string","description":"General ledger code.","example":"4300"},"TransactionTypeCode":{"type":"string","description":"CPA transaction code.","example":"999"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.","example":"2019-11-03 01:00:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","VenmoToken","GLCode","TransactionTypeCode","LastModified"]}}}}}}},"/batch/contacts/add":{"post":{"description":"This endpoint is used to submit multiple contact creation requests to VoPay. Each object in the batch is processed against the /contacts/add endpoint: EmailAddress and PhoneNumber are always required, and either BusinessName or both FirstName and LastName must be provided.","summary":"batch/contacts/add","tags":["Batch Request Endpoints"],"operationId":"BatchContactsAddPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /contacts/add endpoint. This endpoint accepts a maximum of 5000 contacts per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of contacts submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected contacts.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected contacts","example":"{'1': 'Required parameter(s) missing: EmailAddress', '3': 'Required parameter(s) missing: FirstName, LastName'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/eft/fund":{"post":{"description":"This endpoint is used to submit multiple EFT fund transaction requests to VoPay.","summary":"batch/eft/fund","tags":["Batch Request Endpoints"],"operationId":"BatchEFTFundPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /eft/fund endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: FirstName, LastName', '3': 'Required parameter(s) missing: PostalCode'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/eft/withdraw":{"post":{"description":"This endpoint is used to submit multiple EFT withdraw transaction requests to VoPay.","summary":"batch/eft/withdraw","tags":["Batch Request Endpoints"],"operationId":"BatchEFTWithdrawPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /eft/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: FirstName, LastName', '3': 'Required parameter(s) missing: PostalCode'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/interac/money-request":{"post":{"description":"This endpoint is used to submit multiple Interac money request transaction requests to VoPay.","summary":"batch/interac/money-request","tags":["Batch Request Endpoints"],"operationId":"BatchInteracMoneyRequestPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /interac/money-request endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/interac/bulk-payout":{"post":{"description":"This endpoint is used to submit multiple Interac bulk-payout transaction requests to VoPay.","summary":"batch/interac/bulk-payout","tags":["Batch Request Endpoints"],"operationId":"BatchInteracBulkPayoutPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /interac/bulk-payout endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/rtr/withdraw":{"post":{"description":"This endpoint is used to submit multiple VoPay Instant transaction requests to VoPay.","summary":"batch/rtr/withdraw","tags":["Batch Request Endpoints"],"operationId":"BatchVopayInstantPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /rtr/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: FinancialInstitutionNumber', '3': 'Required parameter(s) missing: AccountNumber'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/elinx":{"post":{"description":"This endpoint is used to submit multiple eLinx beneficiary requests to VoPay.","summary":"batch/elinx","tags":["Batch Request Endpoints"],"operationId":"BatchELinxPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /elinx endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/debit-card/push-funds":{"post":{"description":"This endpoint is used to submit multiple debit card oct push funds requests to VoPay.","summary":"batch/debit-card/push-funds","tags":["Batch Request Endpoints"],"operationId":"BatchDebitCardPushFundsPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /debit-card/oct/push-funds endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/ach/fund":{"post":{"description":"This endpoint is used to submit multiple ACH Fund requests to VoPay.","summary":"batch/ach/fund","tags":["Batch Request Endpoints"],"operationId":"BatchACHFundPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /ach/fund endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/ach/withdraw":{"post":{"description":"This endpoint is used to submit multiple ACH Withdraw requests to VoPay.","summary":"batch/ach/withdraw","tags":["Batch Request Endpoints"],"operationId":"BatchACHWithdrawPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /ach/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/credit-card/charge":{"post":{"description":"This endpoint is used to submit multiple Credit Card Charge requests to VoPay.","summary":"batch/credit-card/charge","tags":["Batch Request Endpoints"],"operationId":"BatchCreditCardChargePost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /credit-card/charge endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/rtp/withdraw":{"post":{"description":"This endpoint is used to submit multiple RTP Withdraw requests to VoPay.","summary":"batch/rtp/withdraw","tags":["Batch Request Endpoints"],"operationId":"BatchRTPWithdrawPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /rtp/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/fednow/withdraw":{"post":{"description":"This endpoint is used to submit multiple Fednow Withdraw requests to VoPay.","summary":"batch/fednow/withdraw","tags":["Batch Request Endpoints"],"operationId":"BatchFednowWithdrawPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /fednow/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/fedwire/fund":{"post":{"description":"This endpoint is used to submit multiple Fedwire Fund requests to VoPay.","summary":"batch/fedwire/fund","tags":["Batch Request Endpoints"],"operationId":"BatchFedwireFundPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /fedwire/fund endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch/fedwire/withdraw":{"post":{"description":"This endpoint is used to submit multiple Fedwire Withdraw requests to VoPay.","summary":"batch/fedwire/withdraw","tags":["Batch Request Endpoints"],"operationId":"BatchFedwireWithdrawPost","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"},"BatchName":{"description":"Name of the batch","type":"string"},"BatchData":{"description":"An array of objects. Each object contains the input params for the /fedwire/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.","type":"string"}},"required":["AccountID","Key","Signature","BatchName","BatchData"]}}},"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":""},"BatchTransactionRequestID":{"type":"integer","description":"Unique ID of your batch transaction request.","example":"123456"},"TotalSubmittedTransactions":{"type":"integer","description":"Total number of transactions submitted.","example":"1000"},"NumberOfRejectedTransactions":{"type":"integer","description":"Total number of rejected transactions.","example":"5"},"RejectedTransactions":{"type":"string","description":"JSON object containing the rejected transactions","example":"{'1': 'Required parameter(s) missing: SenderName', '3': 'Required parameter(s) missing: EmailAddress'}","x-absent-when":"no rejected transactions"}},"required":["Success","ErrorMessage","BatchTransactionRequestID","TotalSubmittedTransactions","NumberOfRejectedTransactions"]}}}}}}},"/batch":{"get":{"description":"This endpoint is used to fetch a listing of all your batch transaction requests","summary":"batch","tags":["Batch Request Endpoints"],"operationId":"BatchGet","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":"TransactionType","in":"query","required":false,"description":"Filters results by transaction type: EFT, Interac, or Paylink. Default is '' (i.e., batch transaction requests of all transaction types are returned).","schema":{"type":"string"}},{"name":"PaymentType","in":"query","required":false,"description":"Filters results by payment type: Credit or Debit. Default is '' (i.e., batch transaction requests of all payment types are returned).","schema":{"type":"string"}},{"name":"FromDate","in":"query","required":false,"description":"Returns all batch transaction requests submitted after this date. Date format is YYYY-MM-DD.","schema":{"type":"string"}},{"name":"ToDate","in":"query","required":false,"description":"Returns all batch transaction requests submitted before this date. Date format is YYYY-MM-DD.","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the sending was successful, false if it failed","example":true},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"Batches":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Array of objects. Each object contains the details of each batch transaction request","properties":{"0":{"type":"object","properties":{"BatchTransactionRequestID":{"type":"integer","description":"The unique ID of the batch transaction request","example":"1234"},"BatchName":{"type":"string","description":"Name of the submitted batch.","example":"Funding transactions - Jan 2022"},"TransactionType":{"type":"string","description":"EFT, Interac, or Paylink","example":"EFT"},"PaymentType":{"type":"string","description":"Credit or Debit","example":"Credit"},"NumRecords":{"type":"integer","description":"Number of transaction requests in the batch","example":"950"},"TotalAmount":{"type":"number","description":"Total amount of all transactions in the submitted batch","example":"4560.34"},"DateAdded":{"type":"string","description":"Date the batch transaction request was submitted","example":"2022-01-12"},"TotalSubmitted":{"type":"integer","description":"Total number of transactions that are still in submitted status","example":"45"},"TotalCreated":{"type":"integer","description":"Total number of transactions that have been created","example":"900"},"TotalFailed":{"type":"integer","description":"Total number of transactions that failed to create","example":"5"}},"required":["BatchTransactionRequestID","BatchName","TransactionType","PaymentType","NumRecords","TotalAmount","DateAdded","TotalSubmitted","TotalCreated","TotalFailed"]}},"x-empty-when":"no batches match","x-list-of":"inline"}},"required":["Success","ErrorMessage","Batches"]}}}}}}},"/batch/details":{"get":{"description":"This endpoint is used to fetch the details of a specific batch transaction request","summary":"batch/details","tags":["Batch Request Endpoints"],"operationId":"BatchDetailsGet","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":"BatchTransactionRequestID","in":"query","required":true,"description":"Unique ID of the batch transaction request you want to fetch the details for.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the sending was successful, false if it failed","example":true},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"BatchDetails":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Array of objects. Each object contains the details of each transaction in the batch transaction request.","properties":{"0":{"type":"object","properties":{"BatchTransactionRequestDetailsRecordID":{"type":"integer","description":"The unique ID of the batch transaction request detail","example":"1234"},"TransactionPayload":{"type":"object","description":"JSON object of the submitted transaction"},"TransactionID":{"type":"integer","description":"Unique ID of the created transaction, if applicable","example":"4567"},"ScheduledTransactionID":{"type":"integer","description":"Unique ID of the created scheduled transaction, if applicable","example":"678"},"ELinxRequestID":{"type":"integer","description":"Unique ID of the created eLinx request, if applicable","example":"789"},"FailureReason":{"type":"string","description":"Reason the transaction failed to create, if applicable","example":"Missing first name"},"Status":{"type":"string","description":"Status of the transaction. Possible values are: submitted, created","example":"2022-01-12"}},"required":["BatchTransactionRequestDetailsRecordID","TransactionPayload","TransactionID","ScheduledTransactionID","ELinxRequestID","FailureReason","Status"]}},"x-empty-when":"no batch details match","x-list-of":"inline"}},"required":["Success","ErrorMessage","BatchDetails"]}}}}}}},"/journal-entry/add":{"post":{"description":"This endpoint allows you to add journal entry into the VoPay platform. Journals do not represent real funds. They are considered offbook funds, and are designed to represent transactions that have occured outside the VoPay platform.","summary":"journal-entry/add","tags":["Journal Entry Endpoints"],"operationId":"JournalEntryAddPost","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"},"Currency":{"description":"3 character currency code for the currency to mark the currency that was used for the journal entry.","type":"string"},"CreditAmount":{"description":"The credit amount for the journal entry. Either one of CreditAmount or DebitAmount must be provided.","type":"string"},"DebitAmount":{"description":"The debit amount for the journal entry. Either one of CreditAmount or DebitAmount must be provided.","type":"string"},"TransactionDate":{"description":"The transaction date for the journal entry. Must be specified in YYYY-MM-DD format.","type":"string","format":"date"},"FullName":{"description":"Full name of the indivdual or business for whom the journal entry is being created.","type":"string"},"Status":{"description":"The transaction status for the journal entry.","type":"string"},"Notes":{"description":"An optional note to associate with the journal entry.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the journal entry.","type":"string"},"ClientAccountID":{"description":"The Client Account ID that the journal entry belong to.","type":"string","format":"int32"}},"required":["AccountID","Key","Signature","Currency","CreditAmount","DebitAmount","TransactionDate","FullName","Status"]}}},"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":""},"JournalEntryID":{"type":"integer","description":"The unique ID of the journal entry that was just created. This ID should be saved as it is required in order to look up or edit the journal entry.","example":"1122"}},"required":["Success","ErrorMessage","JournalEntryID"]}}}}}}},"/journal-entry/edit":{"post":{"description":"This endpoint allows you to edit journal entry that was previously saved the VoPay platform.","summary":"journal-entry/edit","tags":["Journal Entry Endpoints"],"operationId":"JournalEntryEditPost","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"},"JournalEntryID":{"description":"Searches for a journal entry transaction with the specified journal entry ID. If the journal entry ID is not found in our system, an error will be thrown.","type":"integer","format":"int32"},"Currency":{"description":"3 character currency code for the currency to mark the currency that was used for the journal entry. If specified, the specified journal entry will be updated with the new value.","type":"string"},"CreditAmount":{"description":"The credit amount for the journal entry. Only one of the CreditAmount or DebitAmount can be non-zero.","type":"string"},"DebitAmount":{"description":"The debit amount for the journal entry. Only one of the CreditAmount or DebitAmount can be non-zero.","type":"string"},"TransactionDate":{"description":"The transaction date for the journal entry. Should be specified in YYYY-MM-DD format. If specified, the specified journal entry will be updated with the new value.","type":"string","format":"date"},"FullName":{"description":"Full name of the indivdual or business for whom the journal entry is being created. If specified, the specified journal entry will be updated with the new value.","type":"string"},"Status":{"description":"The transaction status for the journal entry. If specified, the specified journal entry will be updated with the new value.","type":"string"},"Notes":{"description":"An optional note to associate with the journal entry transaction. If specified, the specified journal entry will be updated with the new value.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the journal entry transaction. If specified, the specified journal entry will be updated with the new value.","type":"string"},"ClientAccountID":{"description":"The Client Account ID that the journal entry belongs to. If specified, the specified journal entry will be updated with the new value.","type":"string","format":"int32"}},"required":["AccountID","Key","Signature","JournalEntryID"]}}},"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":""},"JournalEntryID":{"type":"integer","description":"The unique ID of the journal entry that was edited.","example":"1122"}},"required":["Success","ErrorMessage","JournalEntryID"]}}}}}}},"/journal-entry/delete":{"post":{"description":"This endpoint allows you to delete journal entry that was previously saved the VoPay platform.","summary":"journal-entry/delete","tags":["Journal Entry Endpoints"],"operationId":"JournalEntryDeletePost","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"},"JournalEntryID":{"description":"Searches for a journal entry with the specified journal entry ID. If the journal entry ID is not found in our system, an error will be thrown.","type":"integer","format":"int32"}},"required":["AccountID","Key","Signature","JournalEntryID"]}}},"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":""},"JournalEntryID":{"type":"integer","description":"The unique ID of the journal entry that was deleted.","example":"1122"}},"required":["Success","ErrorMessage","JournalEntryID"]}}}}}}},"/journal-entry/transfer":{"post":{"description":"This endpoint allows you to transfer offbook funds between VoPay accounts and/or Client accounts. This endpoint will create two journal entries, one to debit the source account and one to credit the destination account.","summary":"journal-entry/transfer","tags":["Journal Entry Endpoints"],"operationId":"JournalEntryDeleteTransfer","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"},"RecipientAccountID":{"description":"Account ID of the account for which you want to transfer funds to. If you are transfering funds between client accounts, this field should be empty.","type":"string"},"DebitorClientAccountID":{"description":"ID of the client account transferring the funds","type":"string"},"RecipientClientAccountID":{"description":"ID of the client account receiving the funds","type":"string"},"Amount":{"description":"The transfer amount.","type":"number"},"Currency":{"description":"3 character currency code for the currency to mark the currency of the transfered funds.","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transfer","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"}},"required":["AccountID","Key","Signature","Amount","Currency"]}}},"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":""},"JournalEntryID":{"type":"integer","description":"The unique ID of the journal entry that was created for transfer.","example":"1122"}},"required":["Success","ErrorMessage","JournalEntryID"]}}}}}}},"/journal-entry":{"get":{"description":"This endpoint allows you to get the journal entry that was previously saved the VoPay platform.","summary":"journal-entry","tags":["Journal Entry Endpoints"],"operationId":"JournalEntryGet","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"},"JournalEntryID":{"description":"Searches for a journal entry transaction with the specified journal entry ID. If the journal entry ID is not found in our system, an error will be thrown. If a journal entry ID is not passed then it will return all the journal entry for the account.","type":"integer","format":"int32"}},"required":["AccountID","Key","Signature"]}}},"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":""},"Journals":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of journal entry data","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"integer","description":"Unique ID for the Journal entry transaction","example":"5918"},"ClientAccountID":{"type":"string","description":"Client account ID used on the journal entry, if applicable","example":"client_account_1"},"WalletID":{"type":"string","description":"Wallet ID used on the journal entry, if applicable","example":"client_account_wallet_1"},"FullName":{"type":"string","description":"Full name used for the journal entry transaction.","example":"Jane Doe"},"Currency":{"type":"string","description":"3 character currency code.","example":"CAD"},"CreditAmount":{"type":"number","description":"Credit Amount on the journal entry.","example":"123.45"},"DebitAmount":{"type":"string","description":"Debit Amount on the journal entry.","example":"456.78"},"TransactionDate":{"type":"string","format":"date","description":"The date on which the journal entry transaction occurred.","example":"2019-12-04"},"Status":{"type":"string","description":"A message indicating the current status associated with the journal entry transaction.","example":"in progress"},"Notes":{"type":"string","description":"If applicable, notes giving context to the journal entry transaction.","example":"Transaction cancelled"},"ClientReferenceNumber":{"type":"string","description":"The optional reference number which was set when the transaction was created.","example":"null"},"DateAdded":{"type":"string","format":"date","description":"This timestamp indicates when the transaction record was created.","example":"2019-11-03 01:00:00"},"LastModified":{"type":"string","format":"date-time","description":"This timestamp indicates when the transaction record was last modified.","example":"2019-12-04 18:13:39"}},"required":["TransactionID","ClientAccountID","WalletID","FullName","Currency","CreditAmount","DebitAmount","TransactionDate","Status","Notes","ClientReferenceNumber","DateAdded","LastModified"]}},"x-empty-when":"no journal entries match","x-list-of":"inline"}},"required":["Success","ErrorMessage","Journals"]}}}}}}},"/sepa/withdraw":{"post":{"description":"This endpoint debits your account by sending a SEPA Instant payment to a creditor's IBAN. Only EUR currency is supported. Requires SEPAInstantWithdrawEnabled permission and an active EUR virtual account.","summary":"sepa/withdraw","tags":["SEPA Endpoints"],"operationId":"SepaWithdrawPost","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"},"Amount":{"description":"The amount to send via SEPA Instant payment","type":"number"},"RecipientName":{"description":"The full name of the recipient (creditor)","type":"string"},"IBAN":{"description":"The recipient's International Bank Account Number (IBAN)","type":"string"},"Currency":{"description":"The currency for the transaction. Must be EUR","type":"string","default":"EUR"},"ClientAccountID":{"description":"The ID of the client account to associate with this transaction","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number for your own records","type":"string"},"IdempotencyKey":{"description":"A unique key to ensure idempotent request processing","type":"string"},"Notes":{"description":"Optional notes to attach to the transaction","type":"string"},"ParentTransactionID":{"description":"The ID of a parent transaction to link this transaction to","type":"string"},"GLCode":{"description":"General ledger code for accounting purposes","type":"string"},"TransactionTypeCode":{"description":"A custom transaction type code for categorization","type":"string"}},"required":["AccountID","Key","Signature","Amount","RecipientName","IBAN"]}}},"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the SEPA withdrawal transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"The current status of the transaction","example":"pending"},"Flagged":{"type":"string","description":"Present if the transaction was flagged. Contains flag status messages","example":"","x-absent-when":"transaction not flagged"},"Notice":{"type":"string","description":"Present if the account has insufficient funds at the time of the transaction","example":"","x-absent-when":"sufficient balance"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus"]}}}}}}},"/sepa/withdraw/transaction":{"get":{"description":"This endpoint retrieves full details for a single SEPA Instant withdrawal transaction. Requires SEPAInstantWithdrawEnabled permission.","summary":"sepa/withdraw/transaction","tags":["SEPA Endpoints"],"operationId":"SepaWithdrawTransactionGet","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":"TransactionID","in":"query","required":true,"description":"The unique ID of the SEPA withdrawal transaction to retrieve","schema":{"type":"integer"}}],"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":""},"TransactionID":{"type":"integer","description":"The unique ID for the SEPA withdrawal transaction","example":"1124"},"TransactionStatus":{"type":"string","description":"The current status of the transaction","example":"pending"},"TransactionDateTime":{"type":"string","format":"date-time","description":"The date and time the transaction was created","example":"2019-11-26 12:00:00"},"Amount":{"type":"string","description":"The transaction amount formatted to 2 decimal places","example":"100.00"},"Currency":{"type":"string","description":"The currency of the transaction","example":"EUR"},"RecipientName":{"type":"string","description":"The full name of the recipient (creditor)","example":"John Doe"},"IBAN":{"type":"string","description":"The recipient's International Bank Account Number","example":"DE89370400440532013000"},"ClientReferenceNumber":{"type":"string","description":"The reference number set when the transaction was created","example":"REF-12345"},"GLCode":{"type":"string","description":"General ledger code associated with the transaction","example":""},"TransactionTypeCode":{"type":"string","description":"The custom transaction type code associated with the transaction","example":""},"LastModified":{"type":"string","format":"date-time","description":"The timestamp when the transaction record was last modified","example":"2019-12-04 18:13:39"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus","TransactionDateTime","Amount","Currency","RecipientName","IBAN","ClientReferenceNumber","GLCode","TransactionTypeCode","LastModified"]}}}}}}}},"servers":[{"url":"https://earthnode-dev.vopay.com/api/v2"}],"components":{"requestBodies":{"EftScheduleCancelPOST":{"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"},"ScheduledTransactionID":{"description":"ID of the schedule transaction to cancel","type":"integer","format":"int32"}},"required":["AccountID","Key","Signature","ScheduledTransactionID"]}}},"required":true},"CreditCardVoidPost":{"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"},"TransactionID":{"description":"The unique ID for the transaction you want to void","type":"integer"}},"required":["AccountID","Key","Signature","TransactionID"]}}},"required":true},"InteracMoneyRequestTransactionsCancelPost":{"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"},"TransactionID":{"description":"The unique ID for the transaction","type":"string"}},"required":["AccountID","Key","Signature","TransactionID"]}}},"required":true},"RtpWithdrawPost":{"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","type":"string"},"ContactID":{"description":"The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.","type":"string"},"RecipientName":{"description":"Recipient's full name","type":"string"},"AccountNumber":{"description":"Recipient's bank account number. This is the account that funds will be deposited into.","type":"string"},"ABARoutingNumber":{"description":"The ABA Routing number of the recipient's bank account.","type":"string"},"Token":{"description":"Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.","type":"string"},"Amount":{"description":"The amount in the specified currency to deposit into the recipient's bank account.","type":"number"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transaction.","type":"string"},"Notes":{"description":"An optional note to associate with the transaction.","type":"string"},"IdempotencyKey":{"description":"A unique key which the server can use to recognize and reject subsequent retries of the same request.","type":"string"},"ParentTransactionID":{"description":"The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.","type":"string"},"GLCode":{"description":"An optional unique identification general ledger code.","type":"string"},"TransactionTypeCode":{"description":"CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).","type":"string"}},"required":["AccountID","Key","Signature","RecipientName","AccountNumber","ABARoutingNumber","Amount"]}}},"required":true}}}}