VoPay Integrations and Support API

{"openapi":"3.0.0","info":{"version":"2.0","title":"Integrations and Support","description":"The Integrations and Support API defines endpoints for configuring integrations with  Plaid, Flinks, Inverite, and Global Pay, managing API keys, and handling support tickets. It also  includes endpoints for setting and testing webhook URLs, and fetching webhook notifications for  account and partner accounts.","contact":{"name":"API Support","email":"help@vopay.com"}},"paths":{"/account/set-plaid-credentials":{"post":{"description":"This endpoint is used to configure the optional integration with a Plaid account. For more information please visit [our integration section](https://docs.vopay.com/docs/plaid-integration).","summary":"account/set-plaid-credentials","tags":["Integration Endpoints"],"operationId":"SetPlaidCredentialsPost","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"},"PlaidClientID":{"description":"The unique client ID from Plaid","type":"string"},"PlaidSecretKey":{"description":"The unique secret key from Plaid","type":"string"},"PlaidUrl":{"description":"The URL defines the Plaid environment. For example https://sandbox.plaid.com for sandbox, https://development.plaid.com for development, and https://production.plaid.com for production.","type":"string"}},"required":["AccountID","Key","Signature","PlaidClientID","PlaidSecretKey","PlaidUrl"]}}},"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":""},"PlaidClientID":{"type":"string","description":"Your updated plaid client ID","example":"{PlaidClientID}"},"PlaidSecretKey":{"type":"string","description":"Your updated plaid secret key","example":"{PlaidSecretKey}"},"PlaidUrl":{"type":"string","description":"Your updated plaid URL","example":"{PlaidUrl}"}}}}}}}}},"/account/set-flinks-credentials":{"post":{"description":"This endpoint is used to configure the optional integration with a Flinks account. For more information please visit [our integration section](https://docs.vopay.com/docs/flinks-integration).","summary":"account/set-flinks-credentials","tags":["Integration Endpoints"],"operationId":"SetFlinksCredentialsPost","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"},"FlinksUrl":{"description":"The unique API URL from Flinks","type":"string"}},"required":["AccountID","Key","Signature","FlinksUrl"]}}},"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":""},"FlinksUrl":{"type":"string","description":"Your updated Flinks URL","example":"{FlinksUrl}"},"Status":{"type":"string","description":"Updated if the Flinks URL is being updated for your VoPay account","example":"{Status}"}}}}}}}}},"/account/set-inverite-credentials":{"post":{"description":"This endpoint is used to configure the optional integration with a Inverite account. For more information please visit [our integration section](https://docs.vopay.com/docs/inverite-integration).","summary":"account/set-inverite-credentials","tags":["Integration Endpoints"],"operationId":"SetInveriteCredentialsPost","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"},"InveriteAPIKey":{"description":"The unique API Key from Inverite","type":"string"},"InveriteUrl":{"description":"The unique API URL from Inverite (Sandbox or Production)","type":"string"}},"required":["AccountID","Key","Signature","InveriteAPIKey","InveriteUrl"]}}},"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":""},"InveriteAPIKey":{"type":"string","description":"Your updated Inverite API Key","example":"{InveriteAPIKey}"},"InveriteUrl":{"type":"string","description":"Your updated Inverite API URL","example":"{InveriteUrl}"}}}}}}}}},"/account/set-global-pay-credentials":{"post":{"description":"This endpoint is used to configure the optional integration with a Global Pay account. For more information please visit [our integration section](https://docs.vopay.com/docs/global-pay-integration).","summary":"account/set-global-pay-credentials","tags":["Integration Endpoints"],"operationId":"SetGlobalPayCredentialsPost","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"},"GlobalPayAppID":{"description":"Your unique Global Pay app ID","type":"string"},"GlobalPaySharedSecret":{"description":"Your unique Global Pay shared secret","type":"string"}},"required":["AccountID","Key","Signature","GlobalPayAppID","GlobalPaySharedSecret"]}}},"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":""},"GlobalPayAppID":{"type":"string","description":"Your updated Global Pay App ID","example":"{GlobalPayAppID}"},"GlobalPaySharedSecret":{"type":"string","description":"Your updated Global Pay shared secret key","example":"{GlobalPaySharedSecret}"},"Status":{"type":"string","description":"Request status","example":"Updated"}}}}}}}}},"/account/tickets":{"get":{"description":"This endpoint is used to fetch a list of support tickets via our API. If no email address is passed in then it will fetch all tickets for the account. If an email address is passed in, it will fetch all tickets for the account that have been submitted, including CC'd, by that email.","summary":"account/tickets","tags":["Support Endpoints"],"operationId":"fetchTicketsGET","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":"Email","in":"query","required":false,"description":"An email address","schema":{"type":"string"}},{"name":"Limit ","in":"query","required":false,"description":"Limit the number of records that are returned. The limit and default value is 100. This parameter can only be used with Email parameter.","schema":{"type":"integer"}},{"name":"Offset ","in":"query","required":false,"description":"Use this parameter to set the starting point in the dataset. This parameter can only be used with Email parameter.","schema":{"type":"integer"}},{"name":"StartDate","in":"query","required":false,"description":"The start date of the date range you wish to fetch. Format: YYYY-MM-DD","schema":{"type":"string"}},{"name":"EndDate","in":"query","required":false,"description":"The end date of the date range you wish to fetch. Format: YYYY-MM-DD","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":""},"Tickets":{"type":"object","description":"Collection of tickets","properties":{"0":{"type":"object","properties":{"id":{"type":"string","description":"ID of the ticket.","example":""},"subject":{"type":"string","description":"The subject of the ticket.","example":""},"status":{"type":"string","description":"The status of the ticket.","example":""},"dateAdded":{"type":"string","description":"The date when the ticket was added.","example":""},"lastUpdated":{"type":"string","description":"The date when the ticket was last updated.","example":""}}}}},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of eLinx records in that search range.","example":"1000"},"Offset":{"type":"string","description":"Use this parameter to set the starting point in the dataset.","example":"1000"},"Limit":{"type":"string","description":"Limit the number of records that are returned.","example":"1000"}}}}}}}}}}},"/account/submit-ticket":{"post":{"description":"This endpoint is used to submit support tickets via our API.","summary":"account/submit-ticket","tags":["Support Endpoints"],"operationId":"submitTicketPOST","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"},"SenderEmailAddress":{"description":"Your email address","type":"string"},"TicketRequesterName":{"description":"The full name of the submitter of your ticket","type":"string"},"TicketSubject":{"description":"The subject of your ticket","type":"string"},"TicketContent":{"description":"The body of your ticket","type":"string"},"TicketCategory":{"description":"The category of your ticket. Valid values are: Client Onboarding,Product Issues,Billing Issues,Feature Request,General Inquiry,Account Limits,General Feedback,Transaction Inquiry","type":"string"},"TransactionID":{"description":"If the issue pertains to a specific transaction, you can use this input to provide the unique transaction ID","type":"string"},"CcEmails":{"description":"A comma-delimited list of CC email addresses to include on the ticket. These email addresses will be included on the correspondence","type":"string"}},"required":["AccountID","Key","Signature","SenderEmailAddress","TicketRequesterName","TicketSubject","TicketContent","TicketCategory"]}}},"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":""},"TicketID":{"type":"integer","description":"Support Ticket ID","example":""}}}}}}}}},"/account/submit-ticket-comment":{"post":{"description":"This endpoint is used to submit a comment on an existing support tickets via our API. Ticket comments represent the conversation between user and support team. Use the TicketID (obtained from /account/submit-ticket endpoint) to identify the ticket you want to attach the comment to","summary":"account/submit-ticket-comment","tags":["Support Endpoints"],"operationId":"submitTicketCommentPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/submitTicketCommentPOST"},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""}}}}}}}}},"/account/ticket-attachment":{"post":{"description":"You can upload a file and attach it to an existing support tickets via our API. Use the TicketID (obtained from /account/submit-ticket endpoint) to identify the ticket you want to attach the file to. Here are some rules regarding the document requirements:\n\n* The maximum allowed file size is 10Mb\n\n* Files must be sent as base64. Make sure the base64 code is valid (must contain the initial file information. E.g. data:image/jpeg;base64\n\n*","summary":"account/ticket-attachment","tags":["Support Endpoints"],"operationId":"submitTicketAttachmentPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/submitTicketAttachmentPOST"},"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":""}}}}}}}}},"/partner/tickets":{"get":{"description":"This endpoint is used to fetch a list of support tickets via our API. If no email address is passed in then it will fetch all tickets for the account. If an email address is passed in, it will fetch all tickets for the account that have been submitted, including CC'd, by that email.","summary":"partner/tickets","tags":["Support Endpoints"],"operationId":"partnerFetchTicketsGET","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":"Email","in":"query","required":false,"description":"An email address","schema":{"type":"string"}},{"name":"Limit ","in":"query","required":false,"description":"Limit the number of records that are returned. The limit and default value is 100. This parameter can only be used with Email parameter.","schema":{"type":"integer"}},{"name":"Offset ","in":"query","required":false,"description":"Use this parameter to set the starting point in the dataset. This parameter can only be used with Email parameter.","schema":{"type":"integer"}},{"name":"StartDate","in":"query","required":false,"description":"The start date of the date range you wish to fetch. Format: YYYY-MM-DD","schema":{"type":"string"}},{"name":"EndDate","in":"query","required":false,"description":"The end date of the date range you wish to fetch. Format: YYYY-MM-DD","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":""},"Tickets":{"type":"object","description":"Collection of tickets","properties":{"0":{"type":"object","properties":{"id":{"type":"string","description":"ID of the ticket.","example":""},"subject":{"type":"string","description":"The subject of the ticket.","example":""},"status":{"type":"string","description":"The status of the ticket.","example":""},"dateAdded":{"type":"string","description":"The date when the ticket was added.","example":""},"lastUpdated":{"type":"string","description":"The date when the ticket was last updated.","example":""}}}}},"Pagination":{"type":"object","description":"Pagination metadata","properties":{"TotalRecords":{"type":"string","description":"Total number of eLinx 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"}}}}}}}}}}},"/partner/submit-ticket":{"post":{"description":"This endpoint is used to submit support tickets via our API.","summary":"partner/submit-ticket","tags":["Support Endpoints"],"operationId":"PartnersubmitTicketPOST","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"},"SenderEmailAddress":{"description":"Your email address","type":"string"},"AccountName":{"description":"The name of the account that's impacted by this issue, if applicable.","type":"string"},"TicketRequesterName":{"description":"The full name of the submitter of your ticket","type":"string"},"TicketSubject":{"description":"The subject of your ticket","type":"string"},"TicketContent":{"description":"The body of your ticket","type":"string"},"TicketCategory":{"description":"The category of your ticket. Valid values are: Client Onboarding,Product Issues,Billing Issues,Feature Request,General Inquiry,Account Limits,General Feedback,Transaction Inquiry","type":"string"},"TransactionID":{"description":"If the issue pertains to a specific transaction, you can use this input to provide the unique transaction ID","type":"string"},"CcEmails":{"description":"A comma-delimited list of CC email addresses to include on the ticket. These email addresses will be included on the correspondence","type":"string"}},"required":["AccountID","Key","Signature","SenderEmailAddress","TicketRequesterName","TicketSubject","TicketContent","TicketCategory"]}}},"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":""},"TicketID":{"type":"integer","description":"Support Ticket ID","example":""}}}}}}}}},"/partner/submit-ticket-comment":{"post":{"description":"This endpoint is used to submit a comment on an existing support tickets via our API. Ticket comments represent the conversation between user and support team. Use the TicketID (obtained from /partner/submit-ticket endpoint) to identify the ticket you want to add the comment to.","summary":"partner/submit-ticket-comment","tags":["Support Endpoints"],"operationId":"submitTicketCommentPartnerPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/submitTicketCommentPOST"},"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":""}}}}}}}}},"/partner/ticket-attachment":{"post":{"description":"You can upload a file and attach it to an existing support tickets via our API. Use the TicketID (obtained from /partner/submit-ticket endpoint) to identify the ticket you want to attach the file to. Here are some rules regarding the document requirements:\n\n* The maximum allowed file size is 10Mb\n\n* Files must be sent as base64. Make sure the base64 code is valid (must contain the initial file information. E.g. data:image/jpeg;base64\n\n*","summary":"partner/ticket-attachment","tags":["Support Endpoints"],"operationId":"submitTicketAttachmentPartnerPOST","deprecated":false,"requestBody":{"$ref":"#/components/requestBodies/submitTicketAttachmentPOST"},"responses":{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"Success":{"type":"boolean","description":"True if the request was successful, false if it failed","example":"true"},"ErrorMessage":{"type":"string","description":"Contains a description of the error if the request failed","example":""}}}}}}}}},"/account/webhook-url":{"post":{"description":"This endpoint will allow the user to add or modify a webhook URL.\n\nThe purpose of the webhook URL is to notify users of any changes in transaction status, paylink status, account status, account verification status, as well as bank account creation, scheduled transaction creation, batch request processed, and batch request failed.","summary":"account/webhook-url","tags":["Webhook Endpoints"],"operationId":"AccountWebhookUrlPost","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"},"WebHookUrl":{"description":"URL where the users want us to send their notifications. This parameter has to be a valid URL. If the field Disabled is added, this field can be optional; otherwise, it will consider as mandatory","type":"string"},"Type":{"description":"The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction, virtualaccountcreated. If left blank changes will be applied to all webhook types.","type":"string"},"Disabled":{"description":"If this parameter is present WebHookUrl is not mandatory.","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":""}}}}}}}}},"/account/webhook-url/info":{"get":{"description":"This endpoint will retrieve your webhook URL.","summary":"account/webhook-url/info","tags":["Webhook Endpoints"],"operationId":"AccountWebhookUrlInfoGet","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":"","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":""},"Webhooks":{"type":"object","description":"Collection of webhook event types configured","properties":{"0":{"type":"object","properties":{"Event":{"type":"string","description":"The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction.","example":""},"Url":{"type":"string","description":"Webhook URL, is the url is not setup it will return empty","example":""}}}}},"WebHookURL":{"type":"string","description":"Webhook URL, is the url is not setup it will return empty. See Webhooks attribute for full list.","example":""}}}}}}}}},"/account/webhook-url/test":{"post":{"description":"In this endpoint, you will be able to test your webhook URL. We will send you an example of the payload that you will receive.","summary":"account/webhook-url/test","tags":["Webhook Endpoints"],"operationId":"AccountWebhookUrlTestPost","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"},"Type":{"description":"The type of webhook notification you wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction. Default is transaction.","type":"string"},"Payload":{"description":"A custom JSON payload to send to the webhook URL. If not provided, a sample payload will be generated based on the Type parameter.","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":""}}}}}}}}},"/account/webhooks":{"get":{"description":"This endpoint can be used to fetch a list of sent webhook notifications. Maximum date range is 1 month. If no date range is provided, it will default to the past 30 days.","summary":"account/webhooks","tags":["Webhook Endpoints"],"operationId":"AccountWebhooksGet","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":"Type","in":"query","required":false,"description":"The type of webhook notification you wish to fetch. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction.","schema":{"type":"string"}},{"name":"WebhookID","in":"query","required":false,"description":"The ID of webhook notifications you wish to fetch.","schema":{"type":"string"}},{"name":"NotificationStatus","in":"query","required":false,"description":"Filter webhook notification by status. Possible values are: new, processed, failed, deprecated.","schema":{"type":"string"}},{"name":"StartDate","in":"query","required":false,"description":"The start date of the date range you wish to fetch. Format: YYYY-MM-DD","schema":{"type":"string"}},{"name":"EndDate","in":"query","required":false,"description":"The end date of the date range you wish to fetch. Format: YYYY-MM-DD","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":""},"Webhooks":{"type":"object","description":"Collection of webhook notifications","properties":{"0":{"type":"object","properties":{"EventID":{"type":"integer","description":"Unique ID for the webhook notification event","example":"123563"},"Event":{"type":"string","description":"The event type of the webnook notification. Possible values are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction.","example":"transaction"},"Module":{"type":"string","description":"Specifies the sub-category of the event type. For example, if the event type is transaction, the module could be eftfunding, achwithdraw, etc.","example":"achfunding"},"WebhookID":{"type":"string","description":"This is the ID provided in the webhook payload. For example, the transaction ID, paylink ID, etc.","example":"12314"},"Status":{"type":"string","description":"This is the Status provied in the webhook payload. For example, the transaction status, paylink status, etc.","example":"in progress"},"NotificationStatus":{"type":"string","description":"This is the Status of the webhook.","example":"new"},"DateSent":{"type":"string","format":"date-time","description":"This is the date and time the original webhook notification was sent.","example":"2024-01-01 12:34:56"},"WebhookUrl":{"type":"string","description":"The webhook URL the notification was sent to.","example":"https://example.com/webhook"},"ResponseText":{"type":"string","description":"This is the webhook response text.","example":"request caught"},"ResponseStatusCode":{"type":"string","description":"This is the webhook response status code.","example":"200"}}}}}}}}}}}}},"/account/webhook/resend":{"post":{"description":"This endpoint will resend the webhook notification associated with the provided event ID. This is useful if you missed a webhook or if you need to reprocess a webhook.\n\n The event ID can be fetched using the [GET /account/webhooks endpoint](https://docs.vopay.com/reference/accountwebhooksget).","summary":"account/webhook/resend","tags":["Webhook Endpoints"],"operationId":"AccountWebhookResendPost","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"},"EventID":{"description":"The event ID of the webhook notification you wish to resend. This ID can be fetched using the GET /account/webhooks endpoint.","type":"string"}},"required":["AccountID","Key","Signature","EventID"]}}},"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":""}}}}}}}}},"/partner/webhook-url":{"post":{"description":"This endpoint will allow the user to modify the webhook URL.\n\nThe purpose of the webhook URL is to notify users of any changes in the status of the accounts you create.","summary":"partner/webhook-url","tags":["Webhook Endpoints"],"operationId":"PartnerWebhookUrlPost","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"},"WebHookUrl":{"description":"URL where the users want us to send their notifications. This parameter has to be a valid URL. If the field Disabled is added, this field can be optional; otherwise, it will consider as mandatory","type":"string"},"Type":{"description":"The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, schedule

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-integrations-and-support.json