{"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":["Success","ErrorMessage"]}}}}}}},"/bank-account":{"get":{"description":"This endpoint retrieves a list of bank accounts associated with your VoPay account","summary":"bank-account","tags":["Bank Account Endpoints"],"operationId":"BankAccountGET","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":"Token","in":"query","required":false,"description":"When provided, this endpoint will only return the bank account associated with this token","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"When provided, this endpoint will only return bank accounts 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 bank accounts linked to your VoPay account. When set to false, it will return a list of your customer's bank accounts.","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"}},{"name":"SearchText","in":"query","required":false,"description":"A text string to search for account holder name.","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":""},"BankAccounts":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of the bank accounts belonging to the account or client account","properties":{"0":{"type":"object","properties":{"AccountHolderName":{"type":"string","description":"Account Holder's name.","example":"John Smith"},"InstitutionName":{"type":"string","description":"Financial institution name.","example":"CIBC"},"FinancialInstituionNumber":{"type":"string","description":"Financial Instituion Number of the bank account.","example":"010"},"BranchTransitNumber":{"type":"string","description":"Branch Transit Number of the bank account","example":"00390"},"AccountNumber":{"type":"string","description":"Masked account number of the bank account.","example":"*****1234"},"Currency":{"type":"string","description":"Currency of bank account.","example":"CAD"},"Token":{"type":"string","description":"Bank account token.","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksAccountID":{"type":"string","description":"Set for clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksLoginID":{"type":"string","description":"Set for clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidAccountID":{"type":"string","description":"Set for clients with a Plaid account","example":"ACBDF-GAFSHD-AHBS-123456"},"InveriteRequestGUID":{"type":"string","description":"Used by clients with an Inverite account","example":"ACBDF-GAFSHD-AHBS-123456"},"ClientControlledBankAccount":{"type":"boolean","description":"Set to 1 if the bank account is linked to your VoPay account","example":true},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default bank account","example":true},"ClientAccountID":{"type":"string","description":"ClientAccountID attached to the bank account.","example":"ClientAccount1"},"ClientReferenceNumber":{"type":"string","description":"ClientReferenceNumber attached to the bank account.","example":"ABC123"},"Address":{"type":"string","description":"Civic address of the account holder.","example":"123 Fake st"},"City":{"type":"string","description":"City of the account holder.","example":"Vancouver"},"Province":{"type":"string","description":"Province of the account holder.","example":"BC"},"PostalCode":{"type":"string","description":"Postal Code of the account holder.","example":"A1A1A1"},"Verified":{"type":"boolean","description":"Has the bank account been verified.","example":true},"ConnectionType":{"type":"string","description":"The bank account connection type. Possible values are: online, manual.","example":"online"},"DateAdded":{"type":"string","format":"date","description":"Date the bank account was added","example":"2019-11-03 01:00:00"}},"required":["AccountHolderName","InstitutionName","FinancialInstituionNumber","BranchTransitNumber","AccountNumber","Currency","Token","FlinksAccountID","FlinksLoginID","PlaidAccountID","InveriteRequestGUID","ClientControlledBankAccount","IsDefault","ClientAccountID","ClientReferenceNumber","Address","City","Province","PostalCode","Verified","ConnectionType","DateAdded"]}},"x-list-of":"inline","x-empty-when":"no bank accounts match"},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of bank account records in that search range.","example":"1000"},"Offset":{"type":"string","description":"Use this parameter to set the starting point in the dataset.","example":"1000"},"Limit":{"type":"string","description":"Limit the number of records that are returned.","example":"1000"}},"x-absent-when":"response uses PaginationMetaData; present only when pagination is requested","required":["TotalRecords","Offset","Limit"]}},"required":["Success","ErrorMessage","BankAccounts"]}}}}}}},"/bank-account/set-my-bank-account":{"post":{"description":"This endpoint allows you to identify a bank account as belonging to the VoPay account holder.\n\n Optionally, you can use this endpoint to identify a bank account as being the VoPay account holder's default operational and/or billing bank account. The VoPay account holder's default operational bank account is used in the /account/fund-my-account and /account/withdraw-my-account endpoints. The VoPay account holder's default billing bank account is used to collect monthly invoices. Note, a VoPay account can only have one default operational and one default billing bank account per currency.","summary":"bank-account/set-my-bank-account","tags":["Bank Account Endpoints"],"operationId":"BankAccountSetMyBankAccountPOST","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"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify bank account as a default bank account","type":"boolean"},"Purpose":{"description":"Identify bank account purpose. Input can be a comma-delimited list. Valid values are: operational and billing. Default value is operational.","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":""},"Token":{"type":"string","description":"Bank account token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default bank account","example":true}},"required":["Success","ErrorMessage","Token","IsDefault"]}}}}}}},"/bank-account/default-bank-account":{"get":{"description":"This endpoint retrieves the default bank account associated with your VoPay account","summary":"bank-account/default-bank-account","tags":["Bank Account Endpoints"],"operationId":"BankAccountDefaultBankAccountGET","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 bank account 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":""},"DefaultOperationalBankAccount":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Default bank account associated with the Account or Client Account","properties":{"0":{"type":"object","properties":{"AccountHolderName":{"type":"string","description":"Account Holder's name.","example":"John Smith"},"InstitutionName":{"type":"string","description":"Financial institution name.","example":"CIBC"},"FinancialInstituionNumber":{"type":"string","description":"Financial Instituion Number of the bank account.","example":"010"},"BranchTransitNumber":{"type":"string","description":"Branch Transit Number of the bank account","example":"00390"},"AccountNumber":{"type":"string","description":"Masked account number of the bank account.","example":"*****1234"},"Currency":{"type":"string","description":"Currency of bank account.","example":"CAD"},"Token":{"type":"string","description":"Bank account token.","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksAccountID":{"type":"string","description":"Set for clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksLoginID":{"type":"string","description":"Set for clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidAccountID":{"type":"string","description":"Set for clients with a Plaid account","example":"ACBDF-GAFSHD-AHBS-123456"},"InveriteRequestGUID":{"type":"string","description":"Used by clients with an Inverite account","example":"ACBDF-GAFSHD-AHBS-123456"},"ClientControlledBankAccount":{"type":"boolean","description":"Set to 1 if the bank account is linked to your VoPay account","example":true},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default bank account","example":true},"ClientAccountID":{"type":"string","description":"ClientAccountID attached to the bank account.","example":"ClientAccount1"},"ClientReferenceNumber":{"type":"string","description":"ClientReferenceNumber attached to the bank account.","example":"ABC123"},"Address":{"type":"string","description":"Civic address of the account holder.","example":"123 Fake st"},"City":{"type":"string","description":"City of the account holder.","example":"Vancouver"},"Province":{"type":"string","description":"Province of the account holder.","example":"BC"},"PostalCode":{"type":"string","description":"Postal Code of the account holder.","example":"A1A1A1"},"DateAdded":{"type":"string","format":"date","description":"Date the bank account was added","example":"2019-11-03 01:00:00"}},"required":["AccountHolderName","InstitutionName","FinancialInstituionNumber","BranchTransitNumber","AccountNumber","Currency","Token","FlinksAccountID","FlinksLoginID","PlaidAccountID","InveriteRequestGUID","ClientControlledBankAccount","IsDefault","ClientAccountID","ClientReferenceNumber","Address","City","Province","PostalCode","DateAdded"]}},"x-list-of":"inline","x-empty-when":"no default operational bank account"},"DefaultBillingBankAccount":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Default bank account associated with the Account or Client Account","properties":{"0":{"type":"object","properties":{"AccountHolderName":{"type":"string","description":"Account Holder's name.","example":"John Smith"},"InstitutionName":{"type":"string","description":"Financial institution name.","example":"CIBC"},"FinancialInstituionNumber":{"type":"string","description":"Financial Instituion Number of the bank account.","example":"010"},"BranchTransitNumber":{"type":"string","description":"Branch Transit Number of the bank account","example":"00390"},"AccountNumber":{"type":"string","description":"Masked account number of the bank account.","example":"*****1234"},"Currency":{"type":"string","description":"Currency of bank account.","example":"CAD"},"Token":{"type":"string","description":"Bank account token.","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksAccountID":{"type":"string","description":"Set for clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"FlinksLoginID":{"type":"string","description":"Set for clients with a Flinks account","example":"ACBDF-GAFSHD-AHBS-123456"},"PlaidAccountID":{"type":"string","description":"Set for clients with a Plaid account","example":"ACBDF-GAFSHD-AHBS-123456"},"InveriteRequestGUID":{"type":"string","description":"Used by clients with an Inverite account","example":"ACBDF-GAFSHD-AHBS-123456"},"ClientControlledBankAccount":{"type":"boolean","description":"Set to 1 if the bank account is linked to your VoPay account","example":true},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default bank account","example":true},"ClientAccountID":{"type":"string","description":"ClientAccountID attached to the bank account.","example":"ClientAccount1"},"ClientReferenceNumber":{"type":"string","description":"ClientReferenceNumber attached to the bank account.","example":"ABC123"},"Address":{"type":"string","description":"Civic address of the account holder.","example":"123 Fake st"},"City":{"type":"string","description":"City of the account holder.","example":"Vancouver"},"Province":{"type":"string","description":"Province of the account holder.","example":"BC"},"PostalCode":{"type":"string","description":"Postal Code of the account holder.","example":"A1A1A1"},"DateAdded":{"type":"string","format":"date","description":"Date the bank account was added","example":"2019-11-03 01:00:00"}},"required":["AccountHolderName","InstitutionName","FinancialInstituionNumber","BranchTransitNumber","AccountNumber","Currency","Token","FlinksAccountID","FlinksLoginID","PlaidAccountID","InveriteRequestGUID","ClientControlledBankAccount","IsDefault","ClientAccountID","ClientReferenceNumber","Address","City","Province","PostalCode","DateAdded"]}},"x-list-of":"inline","x-empty-when":"no default billing bank account"}},"required":["Success","ErrorMessage","DefaultOperationalBankAccount","DefaultBillingBankAccount"]}}}}}}},"/interac/email/add":{"post":{"description":"This endpoint allows you to add an Interac email to your VoPay account. Optionally, you can use this enpoint to also set the email as default for the VoPay account.","summary":"interac/email/add","tags":["Interac Endpoints"],"operationId":"EmailAddPOST","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"},"RecipientName":{"description":"The name of the recipient associated with this email","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"RecipientEmailAddress":{"description":"The Email address to be associated with the account.","type":"string"},"RecipientPhoneNumber":{"description":"The Phone number to be associated with the account.","type":"string"},"Currency":{"description":"3 character currency code. If this is not specified the email will use the account's local currency (CAD).","type":"string"},"Question":{"description":"Security question for this email address.","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"},"Message":{"description":"An optional message to associate with the email address.","type":"string"},"Language":{"description":"Recipient's language preference. Accepted values: en (English as the default) or fr (French).","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transactions","type":"string"},"ClientControlled":{"description":"When set to true, the connected email will be linked to your VoPay account. Default is false.","type":"boolean"}},"required":["AccountID","Key","Signature","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":""},"Token":{"type":"string","description":"The token associated with the email record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"}},"required":["Success","ErrorMessage","Token"]}}}}}}},"/interac/email/edit":{"post":{"description":"This endpoint allows you to update an Interac email associated with your VoPay account.","summary":"interac/email/edit","tags":["Interac Endpoints"],"operationId":"EmailEditPOST","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":"The Token associated with the email record you wish to update.","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"RecipientName":{"description":"The Email address to be associated with the account.","type":"string"},"RecipientEmailAddress":{"description":"The Email address to be associated with the account.","type":"string"},"RecipientPhoneNumber":{"description":"The Phone number to be associated with the account.","type":"string"},"Question":{"description":"Security question for this email address.","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"},"Message":{"description":"An optional message to associate with the email address.","type":"string"},"Language":{"description":"Recipient's language preference. Accepted values: en (English as the default) or fr (French).","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with the transactions","type":"string"},"ClientControlled":{"description":"When set to true, the connected email will be linked to your VoPay account. Default is false.","type":"boolean"}},"required":["AccountID","Key","Signature","Token"]}}},"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":""},"Token":{"type":"string","description":"The token associated with the email record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"}},"required":["Success","ErrorMessage","Token"]}}}}}}},"/interac/email/delete":{"post":{"description":"This endpoint allows you to delete an Interac email associated with your VoPay account.","summary":"interac/email/delete","tags":["Interac Endpoints"],"operationId":"EmailDeletePOST","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":"The Token associated with the email record you wish to update.","type":"string"},"ClientAccountID":{"description":"Client Account ID","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"]}}}}}}},"/interac/email":{"get":{"description":"This endpoint retrieves a list of Interac emails associated with your VoPay account.","summary":"interac/email","tags":["Interac Endpoints"],"operationId":"EmailGET","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":"SearchText","in":"query","required":false,"description":"A text string to search for in the email addresses","schema":{"type":"string"}},{"name":"RecipientName","in":"query","required":false,"description":"The name of the recipient associated with this email","schema":{"type":"string"}},{"name":"RecipientEmailAddress","in":"query","required":false,"description":"The Email address to be associated with the account.","schema":{"type":"string"}},{"name":"RecipientPhoneNumber","in":"query","required":false,"description":"The Phone number to be associated with the account.","schema":{"type":"string"}},{"name":"ClientReferenceNumber","in":"query","required":false,"description":"An optional reference number to associate with the transactions","schema":{"type":"string"}},{"name":"ClientControlled","in":"query","required":false,"description":"When set to true, the connected email will be linked to your VoPay account. Default is false.","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":"","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":""},"InteracEmails":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of email records","properties":{"0":{"type":"object","properties":{"ClientAccountID":{"type":"string","description":"ClientAccountID attached to the email.","example":"ClientAccount1"},"Currency":{"type":"string","description":"Currency associated with the email","example":"CAD"},"ClientControlledEmail":{"type":"string","description":"Set to 1 if the email is linked to your VoPay account.","example":"1"},"RecipientName":{"type":"string","description":"Recipient's name","example":"Bob Smith"},"RecipientEmailAddress":{"type":"string","description":"The email address.","example":"bob@gmail.com"},"RecipientPhoneNumber":{"type":"string","description":"The phone number.","example":"123456789"},"Question":{"type":"string","description":"Security question for the transaction.","example":"What color is the sky"},"Answer":{"type":"string","description":"Answer to the security question","example":"blue"},"Language":{"type":"string","description":"The language preference for the email record. en (English) or fr (French)","example":"en"},"Message":{"type":"string","description":"The message associated with the email address.","example":""},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":"ABC123"},"RegisteredName":{"type":"string","description":"The registered name for the Interac account. Will return 'N/A' if not available.","example":"Bob Smith"},"Alias":{"type":"string","description":"The alias registered to the Interac account. Will return 'N/A' if not available.","example":"bobsmith"},"AutoDepositEnabled":{"type":"boolean","description":"Determine if auto deposit is enabled or not. Will return 'N/A' if not available.","example":true},"CustomerType":{"type":"string","description":"The customer type for the Interac account. Accepted values: RETAIL or CORPORATION. Will return 'N/A' if not available.","example":"RETAIL"},"TransactionLimit":{"type":"number","description":"The transaction limit for the Interac account. Will return 'N/A' if not available.","example":"1000.00"},"IsActive":{"type":"string","description":"Determine if the email is active or not","example":"true"},"IsDefault":{"type":"string","description":"Determine if this is the default email for the given account or not","example":"true"},"Token":{"type":"string","description":"The token associated with the email record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"}},"required":["ClientAccountID","Currency","ClientControlledEmail","RecipientName","RecipientEmailAddress","RecipientPhoneNumber","Question","Answer","Language","Message","ClientReferenceNumber","RegisteredName","Alias","AutoDepositEnabled","CustomerType","TransactionLimit","IsActive","IsDefault","Token"]}},"x-list-of":"inline","x-empty-when":"no email records match"},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of email 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","required":["TotalRecords","Offset","Limit"]}},"required":["Success","ErrorMessage","InteracEmails"]}}}}}}},"/interac/email/set-my-email":{"post":{"description":"This endpoint allows you to identify an Interac email as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify an Interac email as being the VoPay account holder's default email. Note, a VoPay account can only have one default Interac email.","summary":"interac/email/set-my-email","tags":["Interac Endpoints"],"operationId":"EmailSetMyEmailPOST","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"},"Token":{"description":"The Token associated with the email record you wish to update.","type":"string"},"SetAsDefault":{"description":"Set the email record as default for this account.","type":"boolean"}},"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":""},"Token":{"type":"string","description":"The token associated with the email record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"},"IsDefault":{"type":"boolean","description":"The IsDefault status for the udpated record","example":true}},"required":["Success","ErrorMessage","Token","IsDefault"]}}}}}}},"/interac/email/default-email":{"get":{"description":"This endpoint retrieves the default Interac email associated with your VoPay account.","summary":"interac/email/default-email","tags":["Interac Endpoints"],"operationId":"EmailDefaultEmailGET","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 email associated with this 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":""},"DefaultEmail":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of email records","properties":{"0":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency associated with the email","example":"CAD"},"ClientControlledEmail":{"type":"string","description":"Set to 1 if the email is linked to your VoPay account.","example":"1"},"RecipientName":{"type":"string","description":"Recipient's name","example":"Bob"},"RecipientPaymentDetails":{"type":"string","description":"The email address or phone number.","example":"bob@gmail.com"},"Type":{"type":"string","description":"The type of email record. Accepted values: email, phone","example":"email"},"Question":{"type":"string","description":"Security question for the transaction.","example":"What color is the sky"},"Answer":{"type":"string","description":"Answer to the security question","example":"blue"},"Language":{"type":"string","description":"The language preference for the email record. en (English) or fr (French)","example":"en"},"Message":{"type":"string","description":"The message associated with the email address.","example":""},"ClientReferenceNumber":{"type":"string","description":"An optional reference number which was associated with the transaction.","example":"ABC123"},"IsActive":{"type":"string","description":"Determine if the email is active or not","example":"true"},"IsDefault":{"type":"string","description":"Determine if this is the default email for the given account or not","example":"true"},"Token":{"type":"string","description":"The token associated with the email record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"},"DateAdded":{"type":"string","format":"date-time","description":"This timestamp indicates when the email record was added.","example":"2024-05-02 18:28:13"}},"required":["Currency","ClientControlledEmail","RecipientName","RecipientPaymentDetails","Type","Question","Answer","Language","Message","ClientReferenceNumber","IsActive","IsDefault","Token","DateAdded"]}},"x-list-of":"inline","x-empty-when":"no default email"}},"required":["Success","ErrorMessage","DefaultEmail"]}}}}}}},"/interac/auto-deposit":{"get":{"description":"This endpoint is used to fetch Interac auto-deposit status.","summary":"interac/auto-deposit","tags":["Interac Endpoints"],"operationId":"InteracAutoDepositGET","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":"EmailAddress","in":"query","required":true,"description":"The email address to fetch Interac auto-deposit status for.","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":""},"AutoDepositEnabled":{"type":"boolean","description":"Whether auto deposits are enabled for the Interac account.","example":true}},"required":["Success","ErrorMessage","AutoDepositEnabled"]}}}}}}},"/google-pay/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 login to their Google account and generate a token, which can be used in the /google-pay/charge endpoint.","summary":"google-pay/generate-embed-url","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayGenerateEmbedURLPOST","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 Google Pay token generated will be attached to the Client Account ID","type":"string"},"RedirectURL":{"description":"URL to redirect the user to after the Google account is connected.","type":"string"},"RedirectMethod":{"description":"This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.","type":"string"},"ClientControlled":{"description":"When set to true, the Google Pay token added will be linked to your VoPay account. 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"]}}}}}}},"/google-pay/delete":{"post":{"description":"This endpoint allows you to delete a Google Pay token associated with your VoPay account","summary":"google-pay/delete","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayDeletePOST","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"},"GooglePayToken":{"description":"Google Pay token","type":"string"}},"required":["AccountID","Key","Signature","GooglePayToken"]}}},"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"]}}}}}}},"/google-pay":{"get":{"description":"This endpoint retrieves a list of Google Pay credit cards associated with your VoPay account","summary":"google-pay","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayGET","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":"GooglePayToken","in":"query","required":false,"description":"When provided, this endpoint will only return the Google Pay credit cards associated with this token","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"When provided, this endpoint will only return Google Pay 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 Google Pay credit cards linked to your VoPay account. When set to false, it will return a list of your customer's Google Pay tokens.","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 Google Pay 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"},"GooglePayToken":{"type":"string","description":"Google Pay 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"}},"required":["CreditCardHolderName","CreditCardNumber","CreditCardExpiryYear","CreditCardExpiryMonth","CreditCardBrand","GooglePayToken","IsDefault","ClientAccountID"]}},"x-list-of":"inline","x-empty-when":"no Google Pay 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"]}}}}}}},"/google-pay/set-my-google-pay":{"post":{"description":"This endpoint allows you to identify a Google Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Google Pay credit card as being the VoPay account holder's default Google Pay credit card. Note, a VoPay account can only have one default Google Pay credit card.","summary":"google-pay/set-my-google-pay","tags":["Digital Wallet Endpoints"],"operationId":"GooglePaySetMyGooglePayPOST","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"},"GooglePayToken":{"description":"Google Pay token","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify credit card as default Google Pay credit card","type":"boolean"}},"required":["AccountID","Key","Signature","GooglePayToken"]}}},"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":""},"GooglePayToken":{"type":"string","description":"Google Pay token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default Google Pay credit card","example":true}},"required":["Success","ErrorMessage","GooglePayToken","IsDefault"]}}}}}}},"/google-pay/default-google-pay":{"get":{"description":"This endpoint retrieves the default Google Pay credit card associated with your VoPay account","summary":"google-pay/default-google-pay","tags":["Digital Wallet Endpoints"],"operationId":"GooglePayDefaultGooglePayGET","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 Google Pay 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 Google Pay credit card associated with the Account or Client Account","properties":{"0":{"type":"object","properties":{"GooglePayToken":{"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":["GooglePayToken","CreditCardHolderName","CreditCardNumber","CreditCardExpiryYear","CreditCardExpiryMonth","CreditCardBrand"]}},"x-list-of":"inline","x-empty-when":"no default Google Pay card"}},"required":["Success","ErrorMessage","DefaultCreditCard"]}}}}}}},"/apple-pay/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 login to their Apple account and generate a token, which can be used in the /apple-pay/charge endpoint.","summary":"apple-pay/generate-embed-url","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayGenerateEmbedURLPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/ApplePayGenerateEmbedURLPOST"},"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"]}}}}}}},"/apple-pay/delete":{"post":{"description":"This endpoint allows you to delete a Apple Pay token associated with your VoPay account","summary":"apple-pay/delete","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayDeletePOST","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"},"ApplePayToken":{"description":"Apple Pay token","type":"string"}},"required":["AccountID","Key","Signature","ApplePayToken"]}}},"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"]}}}}}}},"/apple-pay":{"get":{"description":"This endpoint retrieves a list of Apple Pay credit cards associated with your VoPay account","summary":"apple-pay","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayGET","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":"ApplePayToken","in":"query","required":false,"description":"When provided, this endpoint will only return the Apple Pay credit cards associated with this token","schema":{"type":"string"}},{"name":"ClientAccountID","in":"query","required":false,"description":"When provided, this endpoint will only return Apple Pay 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 Apple Pay credit cards linked to your VoPay account. When set to false, it will return a list of your customer's Apple Pay tokens.","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 Apple Pay 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"},"ApplePayToken":{"type":"string","description":"Apple Pay 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"}},"required":["CreditCardHolderName","CreditCardNumber","CreditCardExpiryYear","CreditCardExpiryMonth","CreditCardBrand","ApplePayToken","IsDefault","ClientAccountID"]}},"x-list-of":"inline","x-empty-when":"no Apple Pay 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"]}}}}}}},"/apple-pay/set-my-apple-pay":{"post":{"description":"This endpoint allows you to identify a Apple Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Apple Pay credit card as being the VoPay account holder's default Apple Pay credit card. Note, a VoPay account can only have one default Apple Pay credit card.","summary":"apple-pay/set-my-apple-pay","tags":["Digital Wallet Endpoints"],"operationId":"ApplePaySetMyApplePayPOST","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"},"ApplePayToken":{"description":"Apple Pay token","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify credit card as default Apple Pay credit card","type":"boolean"}},"required":["AccountID","Key","Signature","ApplePayToken"]}}},"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":""},"ApplePayToken":{"type":"string","description":"Apple Pay token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default Apple Pay credit card","example":true}},"required":["Success","ErrorMessage","ApplePayToken","IsDefault"]}}}}}}},"/apple-pay/default-apple-pay":{"get":{"description":"This endpoint retrieves the default Apple Pay credit card associated with your VoPay account","summary":"apple-pay/default-apple-pay","tags":["Digital Wallet Endpoints"],"operationId":"ApplePayDefaultApplePayGET","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 Apple Pay 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 Apple Pay credit card associated with the Account or Client Account","properties":{"0":{"type":"object","properties":{"ApplePayToken":{"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":["ApplePayToken","CreditCardHolderName","CreditCardNumber","CreditCardExpiryYear","CreditCardExpiryMonth","CreditCardBrand"]}},"x-list-of":"inline","x-empty-when":"no default Apple Pay card"}},"required":["Success","ErrorMessage","DefaultCreditCard"]}}}}}}},"/paypal/add":{"post":{"description":"This endpoint allows you to add a PayPal account to your VoPay account","summary":"paypal/add","tags":["PayPal Endpoints"],"operationId":"PayPalAddPOST","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 PayPal account.","type":"string"},"PayPalRecipientType":{"description":"The type of the PayPal account identifier. Valid values are 'EMAIL', 'PHONE', 'PAYPAL_ID'.","type":"string"},"RecipientID":{"description":"The recipient ID (email address, phone number, or PayPal ID) of the PayPal account. This value corresponds with the PayPalRecipientType value in the request.","type":"string"},"RecipientName":{"description":"The full name of the PayPal account holder.","type":"string"},"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"}},"required":["AccountID","Key","Signature","PayPalRecipientType","RecipientID","RecipientName"]}}},"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"]}}}}}}},"/paypal/delete":{"post":{"description":"This endpoint allows you to delete a PayPal account from your VoPay account","summary":"paypal/delete","tags":["PayPal Endpoints"],"operationId":"PayPalDeletePOST","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"},"PayPalToken":{"description":"The Token associated with the PayPal account you wish to delete.","type":"string"}},"required":["AccountID","Key","Signature","PayPalToken"]}}},"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"]}}}}}}},"/paypal/recipients":{"get":{"description":"This endpoint allows you fetch a list all of your PayPal recipients","summary":"paypal/recipients","tags":["PayPal Endpoints"],"operationId":"PayPalRecipientsGET","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":"ClientControlled","in":"query","required":false,"description":"When set to true, this endpoint will only return PayPal accounts linked to your VoPay account. When set to false, it will return a list of your customer's PayPal accounts.","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":""},"PaypalRecipients":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. A collection of PayPal recipients","properties":{"0":{"type":"object","properties":{"RecipientName":{"type":"string","description":"The name of the recipient","example":"John Doe"},"RecipientID":{"type":"string","description":"The email address, phone number, or PayPal ID.","example":"bob@gmail.com"},"PayPalRecipientType":{"type":"string","description":"The type of the recipient","example":"EMAIL"},"PayPalToken":{"type":"string","description":"The Token associated with the recipient","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"},"ClientControlledPayPalAccount":{"type":"string","description":"Set to 1 if the PayPal recipient is linked to your VoPay account.","example":"1"},"IsDefault":{"type":"string","description":"Set to 1 if the PayPal recipient is the default","example":"1"}},"required":["RecipientName","RecipientID","PayPalRecipientType","PayPalToken","ClientControlledPayPalAccount","IsDefault"]}},"x-list-of":"inline","x-empty-when":"no PayPal recipients match"}},"required":["Success","ErrorMessage","PaypalRecipients"]}}}}}}},"/paypal/set-my-recipient":{"post":{"description":"This endpoint allows you to identify a PayPal recipient as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a PayPal recipient as being the VoPay account holder's default PayPal recipient. Note, a VoPay account can only have one default PayPal recipient.","summary":"paypal/set-my-recipient","tags":["PayPal Endpoints"],"operationId":"PayPalSetMyRecipientPOST","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"},"PayPalToken":{"description":"The token identifying the PayPal wallet to send funds to.","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify credit card as default PayPal recipient","type":"boolean"}},"required":["AccountID","Key","Signature","PayPalToken"]}}},"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":""},"PayPalToken":{"type":"string","description":"PayPal recipient token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default PayPal recipient","example":true}},"required":["Success","ErrorMessage","PayPalToken","IsDefault"]}}}}}}},"/paypal/default-recipient":{"get":{"description":"This endpoint retrieves the default PayPal recipient associated with your VoPay account","summary":"paypal/default-recipient","tags":["PayPal Endpoints"],"operationId":"PayPalDefaultRecipientGET","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 PayPal recipient 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":""},"DefaultPayPalRecipient":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of PayPal Recipient records","properties":{"0":{"type":"object","properties":{"ClientControlledPayPalAccount":{"type":"string","description":"Set to 1 if the PayPal recipient is linked to your VoPay account.","example":"1"},"RecipientName":{"type":"string","description":"Recipient's name","example":"Bob"},"RecipientID":{"type":"string","description":"The email address, phone number, or PayPal ID.","example":"bob@gmail.com"},"PayPalRecipientType":{"type":"string","description":"The type of PayPal recipient record. Accepted values: EMAIL, PHONE, or PAYPAL_ID","example":"EMAIL"},"IsActive":{"type":"string","description":"Determine if the PayPal recipient is active or not","example":"true"},"IsDefault":{"type":"string","description":"Determine if this is the default PayPal recipient for the given account or not","example":"true"},"PayPalToken":{"type":"string","description":"The token associated with the PayPal recipient record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"},"DateAdded":{"type":"string","format":"date-time","description":"This timestamp indicates when the PayPal recipient record was added.","example":"2024-05-02 18:28:13"}},"required":["ClientControlledPayPalAccount","RecipientName","RecipientID","PayPalRecipientType","IsActive","IsDefault","PayPalToken","DateAdded"]}},"x-list-of":"inline","x-empty-when":"no default PayPal recipient"}},"required":["Success","ErrorMessage","DefaultPayPalRecipient"]}}}}}}},"/paypal/withdraw/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 login to their PayPal account and generate a token, which can be used in the /paypal/withdraw endpoint.","summary":"paypal/withdraw/generate-embed-url","tags":["PayPal Endpoints"],"operationId":"PaypalGenerateEmbedURLPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/ApplePayGenerateEmbedURLPOST"},"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"]}}}}}}},"/venmo/add":{"post":{"description":"This endpoint allows you to add a Venmo account to your VoPay account","summary":"venmo/add","tags":["Venmo Endpoints"],"operationId":"VenmoAddPOST","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 Venmo account.","type":"string"},"VenmoRecipientType":{"description":"The type of the Venmo account identifier. 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 account. This value corresponds with the VenmoRecipientType value in the request.","type":"string"},"RecipientName":{"description":"The full name of the Venmo account holder.","type":"string"}},"required":["AccountID","Key","Signature","VenmoRecipientType","RecipientID","RecipientName"]}}},"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"]}}}}}}},"/venmo/delete":{"post":{"description":"This endpoint allows you to delete a Venmo account from your VoPay account","summary":"venmo/delete","tags":["Venmo Endpoints"],"operationId":"VenmoDeletePOST","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"},"VenmoToken":{"description":"The Token associated with the Venmo account you wish to delete.","type":"string"}},"required":["AccountID","Key","Signature","VenmoToken"]}}},"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"]}}}}}}},"/venmo/recipients":{"get":{"description":"This endpoint allows you fetch a list all of your Venmo recipients","summary":"venmo/recipients","tags":["Venmo Endpoints"],"operationId":"VenmoRecipientsGET","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":"ClientControlled","in":"query","required":false,"description":"When set to true, this endpoint will only return Venmo accounts linked to your VoPay account. When set to false, it will return a list of your customer's Venmo accounts.","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":""},"VenmoRecipients":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. A collection of Venmo recipients","properties":{"0":{"type":"object","properties":{"RecipientName":{"type":"string","description":"The name of the recipient","example":"John Doe"},"RecipientID":{"type":"string","description":"The email address, phone number, or Venmo user handle.","example":"bob@gmail.com"},"VenmoRecipientType":{"type":"string","description":"The type of the recipient","example":"EMAIL"},"VenmoToken":{"type":"string","description":"The Token associated with the recipient","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"},"ClientControlledPayPalAccount":{"type":"string","description":"Set to 1 if the Venmo recipient is linked to your VoPay account.","example":"1"},"IsDefault":{"type":"string","description":"Set to 1 if the Venmo recipient is the default","example":"1"}},"required":["RecipientName","RecipientID","VenmoRecipientType","VenmoToken","ClientControlledPayPalAccount","IsDefault"]}},"x-list-of":"inline","x-empty-when":"no Venmo recipients match"}},"required":["Success","ErrorMessage","VenmoRecipients"]}}}}}}},"/venmo/set-my-recipient":{"post":{"description":"This endpoint allows you to identify a Venmo recipient as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Venmo recipient as being the VoPay account holder's default Venmo recipient. Note, a VoPay account can only have one default Venmo recipient.","summary":"venmo/set-my-recipient","tags":["Venmo Endpoints"],"operationId":"VenmoSetMyRecipientPOST","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"},"VenmoToken":{"description":"The token identifying the Venmo wallet to send funds to.","type":"string"},"ClientAccountID":{"description":"Client Account ID","type":"string"},"SetAsDefault":{"description":"Identify credit card as default Venmo recipient","type":"boolean"}},"required":["AccountID","Key","Signature","VenmoToken"]}}},"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":""},"VenmoToken":{"type":"string","description":"Venmo recipient token","example":"ACBDF-GAFSHD-AHBS-123456"},"IsDefault":{"type":"boolean","description":"Is this the VoPay account holder's default Venmo recipient","example":true}},"required":["Success","ErrorMessage","VenmoToken","IsDefault"]}}}}}}},"/venmo/default-recipient":{"get":{"description":"This endpoint retrieves the default Venmo recipient associated with your VoPay account","summary":"venmo/default-recipient","tags":["Venmo Endpoints"],"operationId":"VenmoDefaultRecipientGET","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 Venmo recipient 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":""},"DefaultVenmoRecipient":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of Venmo Recipient records","properties":{"0":{"type":"object","properties":{"ClientControlledVenmoAccount":{"type":"string","description":"Set to 1 if the Venmo recipient is linked to your VoPay account.","example":"1"},"RecipientName":{"type":"string","description":"Recipient's name","example":"Bob"},"RecipientID":{"type":"string","description":"The email address, phone number, or Venmo user handle.","example":"bob@gmail.com"},"VenmoRecipientType":{"type":"string","description":"The type of Venmo recipient record. Accepted values: EMAIL, PHONE, or USER_HANDLE","example":"EMAIL"},"IsActive":{"type":"string","description":"Determine if the Venmo recipient is active or not","example":"true"},"IsDefault":{"type":"string","description":"Determine if this is the default Venmo recipient for the given account or not","example":"true"},"VenmoToken":{"type":"string","description":"The token associated with the Venmo recipient record","example":"1e7mtunsbhygfnfpm83zd8rig1hqoqu76y618x3eps4omcye0w83mjj2kk884w0o"},"DateAdded":{"type":"string","format":"date-time","description":"This timestamp indicates when the Venmo recipient record was added.","example":"2024-05-02 18:28:13"}},"required":["ClientControlledVenmoAccount","RecipientName","RecipientID","VenmoRecipientType","IsActive","IsDefault","VenmoToken","DateAdded"]}},"x-list-of":"inline","x-empty-when":"no default Venmo recipient"}},"required":["Success","ErrorMessage","DefaultVenmoRecipient"]}}}}}}},"/venmo/withdraw/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 login to their Venmo account and generate a token, which can be used in the /venmo/withdraw endpoint.","summary":"venmo/withdraw/generate-embed-url","tags":["Venmo Endpoints"],"operationId":"VenmoGenerateEmbedURLPOST","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 Venmo token generated will be attached to the Client Account ID","type":"string"},"RedirectURL":{"description":"URL to redirect the user to after the Venmo account is connected.","type":"string"},"RedirectMethod":{"description":"This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.","type":"string"},"ClientControlled":{"description":"When set to true, the Venmo token added will be linked to your VoPay account. 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"]}}}}}}},"/zelle/withdraw":{"post":{"description":"Initiate a Zelle B2C payment to a recipient identified by email address or mobile phone number.","summary":"zelle/withdraw","tags":["Zelle Endpoints"],"operationId":"ZelleWithdrawPOST","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"},"FirstName":{"description":"Recipient's first name","type":"string"},"LastName":{"description":"Recipient's last name","type":"string"},"Amount":{"description":"Payment amount in USD","type":"string"},"EmailAddress":{"description":"Recipient's email address used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided.","type":"string"},"PhoneNumber":{"description":"Recipient's mobile phone number used as their Zelle alias. Either EmailAddress or PhoneNumber must be provided.","type":"string"},"PriorityType":{"description":"Payment priority. Accepted values: STANDARD, INSTANT. Defaults to the account's configured priority type.","type":"string"},"Notes":{"description":"Optional memo or note for the payment","type":"string"},"ClientAccountID":{"description":"Client Account ID to associate with this transaction","type":"string"},"ClientReferenceNumber":{"description":"An optional reference number to associate with this transaction","type":"string"},"IdempotencyKey":{"description":"A unique key to prevent duplicate transactions","type":"string"},"GLCode":{"description":"General ledger code for the transaction","type":"string"},"TransactionTypeCode":{"description":"Custom transaction type code","type":"string"},"ParentTransactionID":{"description":"ID of a parent pre-funding transaction to link to this payment","type":"string"}},"required":["AccountID","Key","Signature","FirstName","LastName","Amount"]}}},"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":"string","description":"Unique identifier for the created Zelle transaction","example":"123456"}},"required":["Success","ErrorMessage","TransactionID"]}}}}}}},"/zelle/withdraw/transaction":{"get":{"description":"Retrieve details of a specific Zelle withdrawal transaction.","summary":"zelle/withdraw/transaction","tags":["Zelle Endpoints"],"operationId":"ZelleWithdrawTransactionGET","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 ID of the Zelle transaction to retrieve","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":""},"TransactionID":{"type":"string","description":"Unique identifier for the transaction","example":"123456"},"TransactionDate":{"type":"string","description":"Date and time the transaction was created","example":"2024-01-15 10:30:00"},"TransactionStatus":{"type":"string","description":"Current status of the transaction","example":"in progress"},"Amount":{"type":"string","description":"Transaction amount formatted to 2 decimal places","example":"100.00"},"RecipientName":{"type":"string","description":"Full name of the recipient","example":"John Smith"},"RecipientEmail":{"type":"string","description":"Recipient's email alias, if used","example":"john.smith@example.com"},"RecipientPhone":{"type":"string","description":"Recipient's mobile phone alias, if used","example":"+12065551234"},"PriorityType":{"type":"string","description":"Payment priority type","example":"STANDARD"},"Notes":{"type":"string","description":"Memo or note associated with the payment","example":"Invoice payment"},"ClientReferenceNumber":{"type":"string","description":"Client reference number associated with the transaction","example":"REF-001"},"LastModified":{"type":"string","description":"Date and time the transaction was last modified","example":"2024-01-15 10:35:00"}},"required":["Success","ErrorMessage","TransactionID","TransactionDate","TransactionStatus","Amount","RecipientName","RecipientEmail","RecipientPhone","PriorityType","Notes","ClientReferenceNumber","LastModified"]}}}}}}},"/zelle/withdraw/transactions":{"get":{"description":"List Zelle withdrawal transactions for the account within a specified date range.","summary":"zelle/withdraw/transactions","tags":["Zelle Endpoints"],"operationId":"ZelleWithdrawTransactionsGET","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 the date range to filter transactions (e.g. 2024-01-01 or 2024-01-01 00:00:00)","schema":{"type":"string"}},{"name":"EndDateTime","in":"query","required":true,"description":"End of the date range to filter transactions (e.g. 2024-01-31 or 2024-01-31 23:59:59)","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":""},"NumberOfRecords":{"type":"integer","description":"Total number of transactions returned","example":"10"},"ZelleTransactions":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of Zelle withdrawal transactions","properties":{"0":{"type":"object","properties":{"TransactionID":{"type":"string","description":"Unique identifier for the transaction","example":"123456"},"TransactionDateTime":{"type":"string","description":"Date and time the transaction was created","example":"2024-01-15 10:30:00"},"Amount":{"type":"string","description":"Transaction amount formatted to 2 decimal places","example":"100.00"},"Status":{"type":"string","description":"Current status of the transaction","example":"in progress"},"RecipientName":{"type":"string","description":"Full name of the recipient","example":"John Smith"},"RecipientEmail":{"type":"string","description":"Recipient's email alias, if used","example":"john.smith@example.com","nullable":true},"RecipientPhone":{"type":"string","description":"Recipient's mobile phone alias, if used","example":"+12065551234","nullable":true},"PriorityType":{"type":"string","description":"Payment priority type","example":"STANDARD","nullable":true},"ClientReferenceNumber":{"type":"string","description":"Client reference number","example":"REF-001"},"Notes":{"type":"string","description":"Memo or note associated with the payment","example":"Invoice payment"},"LastModified":{"type":"string","description":"Date and time the transaction was last modified","example":"2024-01-15 10:35:00"}},"required":["TransactionID","TransactionDateTime","Amount","Status","RecipientName","RecipientEmail","RecipientPhone","PriorityType","ClientReferenceNumber","Notes","LastModified"]}},"x-list-of":"inline","x-empty-when":"no transactions in range"}},"required":["Success","ErrorMessage","NumberOfRecords","ZelleTransactions"]}}}}}}},"/zelle/cancel":{"post":{"description":"Cancel a pending Zelle withdrawal transaction. If the transaction has already been submitted to the processor, a cancellation request will be sent.","summary":"zelle/cancel","tags":["Zelle Endpoints"],"operationId":"ZelleCancelPOST","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 ID of the Zelle transaction to cancel","type":"string"}},"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":"string","description":"ID of the cancelled transaction","example":"123456"},"TransactionStatus":{"type":"string","description":"Updated status of the transaction","example":"cancelled"}},"required":["Success","ErrorMessage","TransactionID","TransactionStatus"]}}}}}}},"/zelle/withdraw/name-match":{"post":{"description":"Approve or reject a Zelle payment that is pending name match verification. When the recipient's registered name does not match the name provided, the payment is held for manual review.","summary":"zelle/withdraw/name-match","tags":["Zelle Endpoints"],"operationId":"ZelleWithdrawNameMatchPOST","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 ID of the Zelle transaction pending name match verification","type":"string"},"Decision":{"description":"Name match decision. Accepted values: APPROVE, REJECT","type":"string"}},"required":["AccountID","Key","Signature","TransactionID","Decision"]}}},"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":"string","description":"ID of the transaction the decision was applied to","example":"123456"},"Decision":{"type":"string","description":"The decision that was submitted","example":"APPROVE"}},"required":["Success","ErrorMessage","TransactionID","Decision"]}}}}}}},"/zelle/recipients":{"get":{"description":"List saved Zelle recipients for the account. Recipients are automatically saved when a Zelle payment is submitted.","summary":"zelle/recipients","tags":["Zelle Endpoints"],"operationId":"ZelleRecipientsGET","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"}}],"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":""},"NumberOfRecords":{"type":"integer","description":"Total number of recipients returned","example":"5"},"Recipients":{"type":"object","description":"Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of saved Zelle recipients","properties":{"0":{"type":"object","properties":{"RecipientName":{"type":"string","description":"Full name of the recipient","example":"John Smith"},"AliasType":{"type":"string","description":"Type of Zelle alias. Possible values: EMAIL, MOBILE","example":"EMAIL"},"AliasValue":{"type":"string","description":"The recipient's Zelle alias (email address or phone number)","example":"john.smith@example.com"}},"required":["RecipientName","AliasType","AliasValue"]}},"x-list-of":"inline","x-empty-when":"no saved recipients"}},"required":["Success","ErrorMessage","NumberOfRecords","Recipients"]}}}}}}}},"servers":[{"url":"https://earthnode-dev.vopay.com/api/v2"}],"components":{"requestBodies":{"ApplePayGenerateEmbedURLPOST":{"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 Apple Pay token generated will be attached to the Client Account ID","type":"string"},"RedirectURL":{"description":"URL to redirect the user to after the Apple account is connected.","type":"string"},"RedirectMethod":{"description":"This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.","type":"string"},"ClientControlled":{"description":"When set to true, the Apple Pay token added will be linked to your VoPay account. Default is false.","type":"boolean"}},"required":["AccountID","Key","Signature","RedirectURL"]}}},"required":true}}}}