VoPay Payment Methods API

{"openapi":"3.0.0","info":{"version":"2.0","title":"Payment Methods","description":"The Payment Methods API allows you to manage your payment methods.  You can add, delete, and set default payment methods.","contact":{"name":"API Support","email":"help@vopay.com"}},"paths":{"/credit-card/generate-embed-url":{"post":{"description":"This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to provide their credit card information, which can be used in the /credit-card/charge endpoint.","summary":"credit-card/generate-embed-url","tags":["Credit Card Endpoints"],"operationId":"CreditCardGenerateEmbedURLPOST","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":"When provided, the credit card added will be attached to the Client Account ID","type":"string"},"RedirectURL":{"description":"URL to redirect the user to after a credit card is added.","type":"string"},"RedirectMethod":{"description":"This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.","type":"string"},"ClientControlled":{"description":"When set to true, the credit card added will be linked to your VoPay account. Default is false.","type":"boolean"},"CardTypeValidation":{"description":"When set to true, the card type will be validated to ensure the entered information represents a credit card. Default is false.","type":"boolean"},"Trigger3DS":{"description":"When set to true, 3DS authentication will be triggered during the card addition process. Default is false.","type":"boolean"}},"required":["AccountID","Key","Signature","RedirectURL"]}}},"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":""},"EmbedURL":{"type":"string","description":"Custom generated iQ11 iframe url for users to use","example":"https://earthnode-dev.vopay.com/iq11/embed/{Key Returned by Vopay}"},"IframeKey":{"type":"string","description":"Unique key attached to the generated iFrame","example":"a1b2c3"}},"required":["Success","ErrorMessage","EmbedURL","IframeKey"]}}}}}}},"/credit-card/delete":{"post":{"description":"This endpoint allows you to delete a credit card associated with your VoPay account","summary":"credit-card/delete","tags":["Credit Card Endpoints"],"operationId":"CreditCardDeletePOST","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"},"CreditCardToken":{"description":"Credit card token","type":"string"}},"required":["AccountID","Key","Signature","CreditCardToken"]}}},"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":""}},"required":["Success","ErrorMessage"]}}}}}}},"/credit-card":{"get":{"description":"This endpoint retrieves a list of credit cards associated with your VoPay account","summary":"credit-card","tags":["Credit Card Endpoints"],"operationId":"CreditCardGET","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":"CreditCardToken","in":"query","required":false,"description":"When provided, this endpoint will only return the credit card associated with this token","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"When provided, this endpoint will only return credit cards associated with this Client Account ID","schema":{"type":"string"}},{"name":"ClientControlled","in":"query","required":false,"description":"When set to true, this endpoint will only return credit cards linked to your VoPay account. When set to false, it will return a list of your customer's credit cards.","schema":{"type":"boolean"}},{"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":"","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":""},"CreditCards":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of the credit cards belonging to the account or client account","properties":{"0":{"type":"object","properties":{"CreditCardHolderName":{"type":"string","description":"Credit card holder's name.","example":"John Smith"},"CreditCardNumber":{"type":"string","description":"Masked credit card number.","example":"*****1234"},"CreditCardExpiryYear":{"type":"string","description":"Expiry year of the credit card","example":"2023"},"CreditCardExpiryMonth":{"type":"string","description":"Expiry month of the credit card","example":"12"},"CreditCardBrand":{"type":"string","description":"Credit card brand","example":"visa"},"CreditCardToken":{"type":"string","description":"Credit card token.","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default credit card","example":true},"ClientAccountID":{"type":"string","description":"ClientAccountID attached to the credit card.","example":"ClientAccount1"},"SendingEligibility":{"type":"string","description":"This credit card's eligibility to send funds.","example":"1"},"ReceivingEligibility":{"type":"string","description":"This credit card's eligibility to receive funds.","example":"1"},"Type":{"type":"string","description":"Verified card type.","example":"credit"},"Brand":{"type":"string","description":"Verified card brand.","example":"mastercard"},"FundsAvailability":{"type":"string","description":"Funds availability time frame after receiving a payment transaction.","example":"immediate"},"InstitutionName":{"type":"string","description":"Financial institution name.","example":"bankcorp bank, the"},"InstitutionCountry":{"type":"string","description":"Financial institution country.","example":"usa"},"AccountStatementCurrency":{"type":"string","description":"Currency of cardholder's account statement","example":"usd"},"AcceptanceBrand":{"type":"string","description":"Acceptance Brand","example":"mcc"},"ProductType":{"type":"string","description":"Product Type","example":"consumer"}},"required":["CreditCardHolderName","CreditCardNumber","CreditCardExpiryYear","CreditCardExpiryMonth","CreditCardBrand","CreditCardToken","IsDefault","ClientAccountID","SendingEligibility","ReceivingEligibility","Type","Brand","FundsAvailability","InstitutionName","InstitutionCountry","AccountStatementCurrency","AcceptanceBrand","ProductType"]}},"x-list-of":"inline","x-empty-when":"no credit cards match"},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of credit card 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":"response uses PaginationMetaData; present only when pagination is requested","required":["TotalRecords","Offset","Limit"]}},"required":["Success","ErrorMessage","CreditCards"]}}}}}}},"/credit-card/set-my-credit-card":{"post":{"description":"This endpoint allows you to identify a credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a credit card as being the VoPay account holder's default credit card. Note, a VoPay account can only have one default credit card.","summary":"credit-card/set-my-credit-card","tags":["Credit Card Endpoints"],"operationId":"CreditCardSetMyCreditCardPOST","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"},"CreditCardToken":{"description":"Credit Card token","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify credit card as default crdit card","type":"boolean"}},"required":["AccountID","Key","Signature","CreditCardToken"]}}},"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":""},"CreditCardToken":{"type":"string","description":"Credit Card token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default credit card","example":true}},"required":["Success","ErrorMessage","CreditCardToken","IsDefault"]}}}}}}},"/credit-card/default-credit-card":{"get":{"description":"This endpoint retrieves the default credit card associated with your VoPay account","summary":"credit-card/default-credit-card","tags":["Credit Card Endpoints"],"operationId":"CreditCardDefaultCreditCardGET","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":"When provided, this endpoint will return the default credit card associated with this Client Account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":true},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"DefaultCreditCard":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Default credit card associated with the Account or Client Account","properties":{"0":{"type":"object","properties":{"CreditCardToken":{"type":"string","description":"A unique token associated with the credit card.","example":"ACBDF-GAFSHD-AHBS-123456"},"CreditCardHolderName":{"type":"string","description":"Credit card holder name.","example":"Natalie Merchant"},"CreditCardNumber":{"type":"string","description":"Masked credit card number.","example":"**** **** **** 1234"},"CreditCardExpiryYear":{"type":"string","description":"Expiry year of credit card.","example":"2022"},"CreditCardExpiryMonth":{"type":"string","description":"Expiry month of credit card.","example":"03"},"CreditCardBrand":{"type":"string","description":"Credit card brand","example":"visa"}},"required":["CreditCardToken","CreditCardHolderName","CreditCardNumber","CreditCardExpiryYear","CreditCardExpiryMonth","CreditCardBrand"]}},"x-list-of":"inline","x-empty-when":"no default credit card"}},"required":["Success","ErrorMessage","DefaultCreditCard"]}}}}}}},"/debit-card/generate-embed-url":{"post":{"description":"This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to provide their card information, which can be used in the /debit-card/oct/push-funds and /debit-card/aft/pull-funds endpoint.","summary":"debit-card/generate-embed-url","tags":["Debit Card Endpoints"],"operationId":"DebtiCardGenerateEmbedURLPOST","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":"When provided, the credit card added will be attached to the Client Account ID","type":"string"},"RedirectURL":{"description":"URL to redirect the user to after a card is added.","type":"string"},"RedirectMethod":{"description":"This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.","type":"string"},"ClientControlled":{"description":"When set to true, the card added will be linked to your VoPay account. Default is false.","type":"boolean"},"CardTypeValidation":{"description":"When set to true, the card type will be validated to ensure the entered information represents a debit card. Default is false.","type":"boolean"},"Trigger3DS":{"description":"When set to true, 3DS authentication will be triggered during the card addition process. Default is false.","type":"boolean"}},"required":["AccountID","Key","Signature","RedirectURL"]}}},"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":""},"EmbedURL":{"type":"string","description":"Custom generated iQ11 iframe url for users to use","example":"https://earthnode-dev.vopay.com/iq11/embed/{Key Returned by Vopay}"},"IframeKey":{"type":"string","description":"Unique key attached to the generated iFrame","example":"a1b2c3"}},"required":["Success","ErrorMessage","EmbedURL","IframeKey"]}}}}}}},"/debit-card/delete":{"post":{"description":"This endpoint allows you to delete a debit card associated with your VoPay account","summary":"debit-card/delete","tags":["Debit Card Endpoints"],"operationId":"DebitCardDeletePOST","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"},"CardToken":{"description":"Debit card token","type":"string"}},"required":["AccountID","Key","Signature","CardToken"]}}},"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":""}},"required":["Success","ErrorMessage"]}}}}}}},"/debit-card":{"get":{"description":"This endpoint retrieves a list of debit cards associated with your VoPay account","summary":"debit-card","tags":["Debit Card Endpoints"],"operationId":"DebitCardGET","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":"DebitCardToken","in":"query","required":false,"description":"When provided, this endpoint will only return the debit card associated with this token","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"When provided, this endpoint will only return debit cards associated with this Client Account ID","schema":{"type":"string"}},{"name":"ClientControlled","in":"query","required":false,"description":"When set to true, this endpoint will only return debit cards linked to your VoPay account. When set to false, it will return a list of your customer's debit cards.","schema":{"type":"boolean"}},{"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":"","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":""},"DebitCards":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of the credit cards belonging to the account or client account","properties":{"0":{"type":"object","properties":{"DebitCardHolderName":{"type":"string","description":"Debit card holder's name.","example":"John Smith"},"DebitCardNumber":{"type":"string","description":"Masked debit card number.","example":"*****1234"},"DebitCardExpiryYear":{"type":"string","description":"Expiry year of the debit card","example":"2023"},"DebitCardExpiryMonth":{"type":"string","description":"Expiry month of the debit card","example":"12"},"DebitCardBrand":{"type":"string","description":"Debit card brand","example":"visa"},"DebitCardToken":{"type":"string","description":"Debit card token.","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default debit card","example":true},"ClientAccountID":{"type":"string","description":"ClientAccountID attached to the debit card.","example":"ClientAccount1"},"SendingEligibility":{"type":"string","description":"This debit card's eligibility to send funds.","example":"1"},"ReceivingEligibility":{"type":"string","description":"This debit card's eligibility to receive funds.","example":"1"},"Type":{"type":"string","description":"Verified card type.","example":"debit"},"Brand":{"type":"string","description":"Verified card brand.","example":"mastercard"},"FundsAvailability":{"type":"string","description":"Funds availability time frame after receiving a payment transaction.","example":"immediate"},"InstitutionName":{"type":"string","description":"Financial institution name.","example":"bankcorp bank, the"},"InstitutionCountry":{"type":"string","description":"Financial institution country.","example":"usa"},"AccountStatementCurrency":{"type":"string","description":"Currency of cardholder's account statement","example":"usd"},"AcceptanceBrand":{"type":"string","description":"Acceptance Brand","example":"mcc"},"ProductType":{"type":"string","description":"Product Type","example":"consumer"}},"required":["DebitCardHolderName","DebitCardNumber","DebitCardExpiryYear","DebitCardExpiryMonth","DebitCardBrand","DebitCardToken","IsDefault","ClientAccountID","SendingEligibility","ReceivingEligibility","Type","Brand","FundsAvailability","InstitutionName","InstitutionCountry","AccountStatementCurrency","AcceptanceBrand","ProductType"]}},"x-list-of":"inline","x-empty-when":"no debit cards match"},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of debit card 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":"response uses PaginationMetaData; present only when pagination is requested","required":["TotalRecords","Offset","Limit"]}},"required":["Success","ErrorMessage","DebitCards"]}}}}}}},"/debit-card/set-debit-card":{"post":{"description":"This endpoint allows you to identify a debit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a debit card as being the VoPay account holder's default debit card. Note, a VoPay account can only have one default debit card.","summary":"debit-card/set-debit-card","tags":["Debit Card Endpoints"],"operationId":"DebitCardSetDebitCardPOST","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"},"CardToken":{"description":"Debit card token","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify card as default debit card","type":"boolean"}},"required":["AccountID","Key","Signature","CardToken"]}}},"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":""},"CardToken":{"type":"string","description":"Debit card token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default debit card","example":true}},"required":["Success","ErrorMessage","CardToken","IsDefault"]}}}}}}},"/debit-card/default-debit-card":{"get":{"description":"This endpoint retrieves the default debit card associated with your VoPay account","summary":"debit-card/default-debit-card","tags":["Debit Card Endpoints"],"operationId":"DebitCardDefaultDebitCardGET","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":"When provided, this endpoint will return the default debit card associated with this Client Account ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":true},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""},"DefaultPushToCard":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Default debit card associated with the Account or Client Account","properties":{"0":{"type":"object","properties":{"PushToCardToken":{"type":"string","description":"A unique token associated with the debit card.","example":"ACBDF-GAFSHD-AHBS-123456"},"CardHolderName":{"type":"string","description":"Debit card holder name.","example":"Natalie Merchant"},"CardNumber":{"type":"string","description":"Masked debit card number.","example":"**** **** **** 1234"},"CardExpiryYear":{"type":"string","description":"Expiry year of debit card.","example":"2022"},"CardExpiryMonth":{"type":"string","description":"Expiry month of debit card.","example":"03"},"CardBrand":{"type":"string","description":"Debit card brand","example":"visa"}},"required":["PushToCardToken","CardHolderName","CardNumber","CardExpiryYear","CardExpiryMonth","CardBrand"]}},"x-list-of":"inline","x-empty-when":"no default debit card"}},"required":["Success","ErrorMessage","DefaultPushToCard"]}}}}}}},"/bank-account/generate-embed-url":{"post":{"description":"This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to log in to their online banking and select a bank account to make a payment from. For additional details on iQ11 and RedirectMethod, please visit our [Iq11 Overview](https://docs.vopay.com/docs/iq11-overview)","summary":"bank-account/generate-embed-url","tags":["Bank Account Endpoints"],"operationId":"BankAccountGenerateEmbedUrlPost","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":"When provided, the bank account submitted will be attached to the Client Account ID","type":"string"},"RedirectURL":{"description":"URL to redirect to after the customer logs in to their online banking account. The bank account token will be passed as a GET parameter, for example https://redirect.com/page?Token=1234","type":"string"},"CompanyName":{"description":"Name of the Company","type":"string"},"Language":{"description":"Language of iQ11 iFrame- en (English) or fr (French). Default value is en (English)","type":"string"},"RedirectMethod":{"description":"This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.","type":"string"},"AccountSelectionMethod":{"description":"This parameter accepts any, online and manual as parameter values. Defaults to any.","type":"string"},"ClientControlled":{"description":"When set to true, the connected bank account will be linked to your VoPay account. Default is false.","type":"boolean"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the bank account.","type":"string"},"TermsAndConditions":{"description":"Used to add your own terms and conditions","type":"string"},"Country":{"description":"This parameter accepts country codes [CA, US]. Default is CA","type":"string"},"WithTransactions":{"description":"Request transaction history when connecting a bank account online. Default is false.","type":"boolean"},"RequireDebitAuthorityAgreement":{"description":"This parameter will determine if we display a debit authority agreement to the end-user before the connect their payment method. You must request this feature to be enabled for your account. Default is true.","type":"boolean"}},"required":["AccountID","Key","Signature","RedirectURL"]}}},"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":""},"EmbedURL":{"type":"string","description":"Custom generated iQ11 iframe url for users to use","example":"https://earthnode-dev.vopay.com/visa_direct/embed/{Key Returned by Vopay}"},"IframeKey":{"type":"string","description":"Unique key attached to the generated iFrame","example":"a1b2c3"}},"required":["Success","ErrorMessage","EmbedURL","IframeKey"]}}}}}}},"/bank-account/add":{"post":{"description":"This endpoint allows you to add a bank account to your VoPay account","summary":"bank-account/add","tags":["Bank Account Endpoints"],"operationId":"BankAccountAddPOST","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":"Contact ID.","type":"string"},"AccountHolderName":{"description":"String that defines the account holder name.","type":"string"},"AccountNumber":{"description":"Customer's bank account number.","type":"string"},"FinancialInstitutionNumber":{"description":"Three digit institution number for a Canadian bank account.","type":"string"},"BranchTransitNumber":{"description":"Five digit branch transit number for a Canadian bank account.","type":"string"},"ABARoutingNumber":{"description":"Nine digit ABA Routing number of a US bank account.","type":"string"},"FlinksAccountID":{"description":"Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated bank account details from Flinks.","type":"string"},"FlinksLoginID":{"description":"Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated bank account details from Flinks.","type":"string"},"PlaidProcessorToken":{"description":"Plaid Processor Token. VoPay will fetch the associated bank account details from Plaid.","type":"string"},"MxProcessorToken":{"description":"Mx Processor Token. VoPay will fetch the associated bank account details from Mx.","type":"string"},"Currency":{"description":"Three letter currency code.","type":"string"},"Address1":{"description":"First line of the address. Ex: 123 Main St.","type":"string"},"City":{"description":"City","type":"string"},"State":{"description":"State","type":"string"},"ZipCode":{"description":"Zip code","type":"string"},"Province":{"description":"Province","type":"string"},"PostalCode":{"description":"Postal code","type":"string"},"Country":{"description":"Two letter country code.","type":"string"}},"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":""}},"required":["Success","ErrorMessage"]}}}}}}},"/bank-account/delete":{"post":{"description":"This endpoint allows you to delete a bank account associated with your VoPay account","summary":"bank-account/delete","tags":["Bank Account Endpoints"],"operationId":"BankAccountDeletePOSt","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"},"Token":{"description":"Bank account token","type":"string"}},"required":["AccountID","Key","Signature","Token"]}}},"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":""}},"required":["Succ

# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-payment-method-api-reference.json