https://docs.stitch.money/assets/js/46d64162.839998a2.js

1"use strict";(globalThis.webpackChunkdocs=globalThis.webpackChunkdocs||[]).push([[3378],{40990(e,n,l){l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>t,metadata:()=>d,toc:()=>m});const d=JSON.parse('{"id":"api/inputs/client-refund-initiate-input","title":"ClientRefundInitiateInput","description":"No description","source":"@site/docs/api/inputs/client-refund-initiate-input.md","sourceDirName":"api/inputs","slug":"/api/inputs/client-refund-initiate-input","permalink":"/api/inputs/client-refund-initiate-input","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"id":"client-refund-initiate-input","title":"ClientRefundInitiateInput"},"sidebar":"defaultSidebar","previous":{"title":"ClientPaymentInitiationRequestCreateInput","permalink":"/api/inputs/client-payment-initiation-request-create-input"},"next":{"title":"CollectionBatchAddInput","permalink":"/api/inputs/collection-batch-add-input"}}');var s=l(58925),a=l(78178);const t={id:"client-refund-initiate-input",title:"ClientRefundInitiateInput"},i=void 0,c={},m=[{value:"Fields",id:"fields",level:3},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">paymentRequestId</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">ID!</code></span> <mark class="gqlmd-mdx-badge">non-null</mark> <mark class="gqlmd-mdx-badge">scalar</mark>',id:"clientrefundinitiateinputpaymentrequestidid-non-null-scalar",level:4},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">amount</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">MoneyInput!</code></span> <mark class="gqlmd-mdx-badge">non-null</mark> <mark class="gqlmd-mdx-badge">input</mark>',id:"clientrefundinitiateinputamountmoneyinput-non-null-input",level:4},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">reason</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">RefundReason!</code></span> <mark class="gqlmd-mdx-badge">non-null</mark> <mark class="gqlmd-mdx-badge">enum</mark>',id:"clientrefundinitiateinputreasonrefundreason-non-null-enum",level:4},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">nonce</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">String!</code></span> <mark class="gqlmd-mdx-badge">non-null</mark> <mark class="gqlmd-mdx-badge">scalar</mark>',id:"clientrefundinitiateinputnoncestring-non-null-scalar",level:4},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">beneficiaryReference</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">String!</code></span> <mark class="gqlmd-mdx-badge">non-null</mark> <mark class="gqlmd-mdx-badge">scalar</mark>',id:"clientrefundinitiateinputbeneficiaryreferencestring-non-null-scalar",level:4},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">clearingType</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">ClearingType</code></span> <mark class="gqlmd-mdx-badge">enum</mark>',id:"clientrefundinitiateinputclearingtypeclearingtype-enum",level:4},{value:'<span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-parent">ClientRefundInitiateInput</code>.<code class="gqlmd-mdx-entity-name">externalReference</code></span><span class="gqlmd-mdx-bullet">\xa0\u25cf\xa0</span><span class="gqlmd-mdx-entity"><code class="gqlmd-mdx-entity-name">String</code></span> <mark class="gqlmd-mdx-badge">scalar</mark>',id:"clientrefundinitiateinputexternalreferencestring-scalar",level:4}];function r(e){const n={a:"a",code:"code",h3:"h3",h4:"h4",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"No description"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-graphql",children:"input ClientRefundInitiateInput {\n  paymentRequestId: ID!\n  amount: MoneyInput!\n  reason: RefundReason!\n  nonce: String!\n  beneficiaryReference: String!\n  clearingType: ClearingType\n  externalReference: String\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"fields",children:"Fields"}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputpaymentrequestidid-non-null-scalar",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"paymentRequestId"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/scalars/id",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"ID!"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"non-null"})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"scalar"})]}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputamountmoneyinput-non-null-input",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"amount"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/inputs/money-input",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"MoneyInput!"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"non-null"})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"input"})]}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputreasonrefundreason-non-null-enum",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"reason"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/enums/refund-reason",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"RefundReason!"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"non-null"})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"enum"})]}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputnoncestring-non-null-scalar",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"nonce"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/scalars/string",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"String!"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"non-null"})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"scalar"})]}),"\n",(0,s.jsx)(n.p,{children:"Randomly generated unique string to ensure idempotency"}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputbeneficiaryreferencestring-non-null-scalar",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"benef

1iciaryReference"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/scalars/string",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"String!"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"non-null"})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"scalar"})]}),"\n",(0,s.jsx)(n.p,{children:"Must be between 1 and 30 characters.\nThe reference that will be displayed on the refunded users statement"}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputclearingtypeclearingtype-enum",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"clearingType"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/enums/clearing-type",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"ClearingType"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"enum"})]}),"\n",(0,s.jsx)(n.p,{children:"Affects how soon the refund will be paid out"}),"\n",(0,s.jsxs)(n.h4,{id:"clientrefundinitiateinputexternalreferencestring-scalar",children:[(0,s.jsx)(n.a,{href:"#",children:(0,s.jsxs)("span",{class:"gqlmd-mdx-entity",children:[(0,s.jsx)("code",{class:"gqlmd-mdx-entity-parent",children:"ClientRefundInitiateInput"}),".",(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"externalReference"})]})}),(0,s.jsx)("span",{class:"gqlmd-mdx-bullet",children:"\xa0\u25cf\xa0"}),(0,s.jsx)(n.a,{href:"/api/scalars/string",children:(0,s.jsx)("span",{class:"gqlmd-mdx-entity",children:(0,s.jsx)("code",{class:"gqlmd-mdx-entity-name",children:"String"})})})," ",(0,s.jsx)("mark",{class:"gqlmd-mdx-badge",children:"scalar"})]}),"\n",(0,s.jsx)(n.p,{children:"A reference field for tracking the refund in external systems.\nMust be at most 100 characters."})]})}function x(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(r,{...e})}):r(e)}}}]);