{"id":12236,"date":"2023-11-22T11:18:45","date_gmt":"2023-11-22T11:18:45","guid":{"rendered":"https:\/\/zealous.co\/help\/docs\/zealous-api\/triggers-12084\/on-refund\/"},"modified":"2023-12-11T17:26:58","modified_gmt":"2023-12-11T17:26:58","slug":"on-refund-12236","status":"publish","type":"docs","link":"https:\/\/zealous.co\/help\/docs\/api\/triggers\/on-refund-12236\/","title":{"rendered":"On Refund"},"content":{"rendered":"\n<div class=\"wp-block-columns alignwide is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<h4 class=\"wp-block-heading\"><strong>Request<\/strong><style>\/*! elementor - v3.14.0 - 26-06-2023 *\/&amp;amp;lt;br \/> .elementor-widget-divider{--divider-border-style:none;--divider-border-width:1px;--divider-color:#0c0d0e;--divider-icon-size:20px;--divider-element-spacing:10px;--divider-pattern-height:24px;--divider-pattern-size:20px;--divider-pattern-url:none;--divider-pattern-repeat:repeat-x}.elementor-widget-divider .elementor-divider{display:flex}.elementor-widget-divider .elementor-divider__text{font-size:15px;line-height:1;max-width:95%}.elementor-widget-divider .elementor-divider__element{margin:0 var(--divider-element-spacing);flex-shrink:0}.elementor-widget-divider .elementor-icon{font-size:var(--divider-icon-size)}.elementor-widget-divider .elementor-divider-separator{display:flex;margin:0;direction:ltr}.elementor-widget-divider--view-line_icon .elementor-divider-separator,.elementor-widget-divider--view-line_text .elementor-divider-separator{align-items:center}.elementor-widget-divider--view-line_icon .elementor-divider-separator:after,.elementor-widget-divider--view-line_icon .elementor-divider-separator:before,.elementor-widget-divider--view-line_text .elementor-divider-separator:after,.elementor-widget-divider--view-line_text .elementor-divider-separator:before{display:block;content:\"\";border-bottom:0;flex-grow:1;border-top:var(--divider-border-width) var(--divider-border-style) var(--divider-color)}.elementor-widget-divider--element-align-left .elementor-divider .elementor-divider-separator>.elementor-divider__svg:first-of-type{flex-grow:0;flex-shrink:100}.elementor-widget-divider--element-align-left .elementor-divider-separator:before{content:none}.elementor-widget-divider--element-align-left .elementor-divider__element{margin-left:0}.elementor-widget-divider--element-align-right .elementor-divider .elementor-divider-separator>.elementor-divider__svg:last-of-type{flex-grow:0;flex-shrink:100}.elementor-widget-divider--element-align-right .elementor-divider-separator:after{content:none}.elementor-widget-divider--element-align-right .elementor-divider__element{margin-right:0}.elementor-widget-divider:not(.elementor-widget-divider--view-line_text):not(.elementor-widget-divider--view-line_icon) .elementor-divider-separator{border-top:var(--divider-border-width) var(--divider-border-style) var(--divider-color)}.elementor-widget-divider--separator-type-pattern{--divider-border-style:none}.elementor-widget-divider--separator-type-pattern.elementor-widget-divider--view-line .elementor-divider-separator,.elementor-widget-divider--separator-type-pattern:not(.elementor-widget-divider--view-line) .elementor-divider-separator:after,.elementor-widget-divider--separator-type-pattern:not(.elementor-widget-divider--view-line) .elementor-divider-separator:before,.elementor-widget-divider--separator-type-pattern:not([class*=elementor-widget-divider--view]) .elementor-divider-separator{width:100%;min-height:var(--divider-pattern-height);-webkit-mask-size:var(--divider-pattern-size) 100%;mask-size:var(--divider-pattern-size) 100%;-webkit-mask-repeat:var(--divider-pattern-repeat);mask-repeat:var(--divider-pattern-repeat);background-color:var(--divider-color);-webkit-mask-image:var(--divider-pattern-url);mask-image:var(--divider-pattern-url)}.elementor-widget-divider--no-spacing{--divider-pattern-size:auto}.elementor-widget-divider--bg-round{--divider-pattern-repeat:round}.rtl .elementor-widget-divider .elementor-divider__text{direction:rtl}.e-con-inner>.elementor-widget-divider,.e-con>.elementor-widget-divider{width:var(--container-widget-width,100%);--flex-grow:var(--container-widget-flex-grow)}<\/style><\/h4>\n\n\n\n<p>Returns the data of any new submissions made to a specific opportunity belonging to your account. <\/p>\n\n\n\n<p>This includes all works made as part of this submission, as well as payment information for that one entry.<\/p>\n<\/div>\n\n\n\n<div class=\"wp-block-column highlighted is-layout-flow wp-block-column-is-layout-flow\">\n<p><strong>Parameters<\/strong><\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>api_key<\/strong> (required)<\/p>\n\n\n\n<p>The API key you have generated on Zealous. Keep it safe, since it gives anyone with it access to your data.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>opportunity_id <\/strong>(required)<\/p>\n\n\n\n<p>The ID of the opportunity you wish this webhook to listen to.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-text-color has-cyan-bluish-gray-color has-alpha-channel-opacity has-cyan-bluish-gray-background-color has-background is-style-wide\"\/>\n\n\n\n<p><strong>entry_id<\/strong> (optional)<\/p>\n\n\n\n<p>The ID of the entry you wish to load.<\/p>\n<\/div>\n<\/div>\n\n\n\n<div style=\"height:64px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-columns alignwide is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<h4 class=\"wp-block-heading\"><strong>Response<\/strong><\/h4>\n\n\n\n<p>Returns the Submission object belonging to the <strong>opportunity_id<\/strong>. <\/p>\n\n\n\n<p>This includes: <\/p>\n\n\n\n<div id=\"wp-block-themeisle-blocks-accordion-28bcb5fd\" data-has-schema=\"false\" class=\"wp-block-themeisle-blocks-accordion icon-first\">\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Submission<\/strong> (submission_&#8230;)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>All information relating to the submission, such as key dates, the title, description, unique ids and more. All data linked to the submission object starts with <strong>submission_<\/strong><\/p>\n<\/div><\/details>\n\n\n\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Candidate<\/strong> (candidate_&#8230;)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>Data relating to the candidate making the submissions such as name, address, email, phone number and more. All data linked to the submission object starts with <strong>candidate_<\/strong><\/p>\n<\/div><\/details>\n\n\n\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Added Works<\/strong> (&#8220;works&#8221;:[&#8230;])<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>A list of objects added to this submission. This could be an upload, embed or text element. Each object contains it&#8217;s own data relating to it. Such as the web address of the upload, the name, id, and dimension&#8217;s of it (if applicable in your process). All data linked to works can be found in the<strong> &#8220;works&#8221; : [&#8230;] <\/strong>list.<\/p>\n<\/div><\/details>\n\n\n\n<details class=\"wp-block-themeisle-blocks-accordion-item\"><summary class=\"wp-block-themeisle-blocks-accordion-item__title\"><div><strong>Payment Details<\/strong> (&#8220;payment&#8221;:)<\/div><\/summary><div class=\"wp-block-themeisle-blocks-accordion-item__content\">\n<p>If you take a payment, the <strong>&#8220;payment:&#8221;<\/strong> object will also be provided with details such as amount, currency, tax breakdown etc.<\/p>\n<\/div><\/details>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\">\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-file=\"JSON Response\" data-lang=\"JSON\" data-show-lang=\"1\"><code>{\n  &quot;id&quot;: &quot;re_3O2bjq2XXXXXXXXXXXXXXXXX&quot;,\n  &quot;created&quot;: &quot;2023-10-23T15:49:23+0000&quot;,\n  &quot;charge&quot;: &quot;ch_3O2bjq2XXXXXXXXXXXXXXXXX&quot;,\n  &quot;payment_intent&quot;: &quot;pi_3O2bjXXXXXXXXXXXXXXXXXXX&quot;,\n  \n  &quot;candidate_id&quot;: &quot;549647XXXXXXXXXX&quot;,\n  &quot;candidate_stripe_id&quot;: &quot;cus_JONGXXXXXXXXXX&quot;,\n  &quot;candidate_email&quot;: &quot;candidate@example.com&quot;,\n  &quot;candidate_name&quot;: &quot;Jane&quot;, \n \n  &quot;amount&quot;: &quot;10.0&quot;,\n  &quot;status&quot;: &quot;succeeded&quot;,\n  &quot;currency&quot;: &quot;gbp&quot;,\n  &quot;reason&quot;: &quot;requested_by_customer&quot;,\n  \n  &quot;receipt_number&quot;: null,\n  &quot;source_transfer_reversal&quot;: null,\n  &quot;transfer_reversal&quot;: null\n}<\/code><\/pre><\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>A breakdown of the data returned to you through the Zealous API when a a refund is initiated for an entry.<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":12084,"menu_order":5,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-12236","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12236","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/comments?post=12236"}],"version-history":[{"count":0,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12236\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/docs\/12084"}],"wp:attachment":[{"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/media?parent=12236"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/zealous.co\/help\/wp-json\/wp\/v2\/doc_tag?post=12236"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}