070e3fb7.62372587.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{104:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){return c})),a.d(t,"metadata",(function(){return b})),a.d(t,"rightToc",(function(){return l})),a.d(t,"default",(function(){return s}));var n=a(2),r=a(6),i=(a(0),a(250)),c={id:"statusTransacoes",title:"Status das transa\xe7\xf5es",hide_title:!0,sidebar_label:"Transaction status"},b={id:"VisaoGeral/statusTransacoes",isDocsHomePage:!1,title:"Status das transa\xe7\xf5es",description:"Transaction status",source:"@site/docs\\VisaoGeral\\status.md",permalink:"/documentation/docs/VisaoGeral/statusTransacoes",sidebar_label:"Transaction status",sidebar:"someSidebar",previous:{title:"Fluxo de integra\xe7\xe3o",permalink:"/documentation/docs/VisaoGeral/fluxo"},next:{title:"Tipos de Integra\xe7\xf5es",permalink:"/documentation/docs/VisaoGeral/tiposIntegracao"}},l=[{value:"Status Table: TRANSACTIONS",id:"status-table-transactions",children:[]},{value:"Status Table: SUBSCRIPTIONS",id:"status-table-subscriptions",children:[]},{value:"Status Table: CARNETS",id:"status-table-carnets",children:[{value:"Examples of TRANSACTION status notifications",id:"examples-of-transaction-status-notifications",children:[]},{value:"Examples of SUBSCRIPTION status notifications",id:"examples-of-subscription-status-notifications",children:[]},{value:"Examples of CARNETS status notifications",id:"examples-of-carnets-status-notifications",children:[]},{value:"Examples of PAYMENT LINK status notifications",id:"examples-of-payment-link-status-notifications",children:[]}]}],o={rightToc:l};function s(e){var t=e.components,a=Object(r.a)(e,["components"]);return Object(i.b)("wrapper",Object(n.a)({},o,a,{components:t,mdxType:"MDXLayout"}),Object(i.b)("h1",{className:"titulo"},"Transaction status"),Object(i.b)("div",{className:"subtitulo"},Object(i.b)("p",null,"The ",Object(i.b)("strong",{parentName:"p"},"Transactions")," flow of Gerencianet works as follows:"),Object(i.b)("p",null,Object(i.b)("img",Object(n.a)({parentName:"p"},{src:"/documentation/img/transacao.png",alt:"alt text",title:"Status_das_Transacoes"}))),Object(i.b)("br",null),Object(i.b)("h2",{id:"status-table-transactions"},"Status Table: TRANSACTIONS"),Object(i.b)("p",null,"Next, check the table containing the list of all possible statuses of a transaction:"),Object(i.b)("table",null,Object(i.b)("thead",{parentName:"table"},Object(i.b)("tr",{parentName:"thead"},Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:"center"}),"Description"))),Object(i.b)("tbody",{parentName:"table"},Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"new")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Charge generated, awaiting definition of payment method.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"waiting")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Payment method selected, awaiting payment confirmation.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"paid")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Payment confirmed.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"unpaid")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Unable to confirm payment of charge.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"refunded")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Payment returned by the merchant or the intermediary Gerencianet.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"contested")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Payment in dispute process.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"canceled")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Charge canceled by seller or payer.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"settled")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Charge was confirmed manually.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"link")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Status applicable to Payment Link. This status indicates that this is a charge that is associated with a payment link.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"expired")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Status applicable to Payment Link. A payment link will receive this status when it reaches the expiration date defined in the expire_at field when consuming the /charge/:id/link endpoint.")))),Object(i.b)("p",null,"All transactions have ",Object(i.b)("em",{parentName:"p"},"status"),", which represents the ",Object(i.b)("em",{parentName:"p"},"status")," of that transaction. Check out some examples:"),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"When generating a charge (also called a transaction), it has the initial status of ",Object(i.b)("code",null,"new")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-null-para-new.png",alt:"Exemplo de status new",target:"_blank"},"example"),"), that is, the charge has been generated and is awaiting the definition of the payment method;")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"Once this transaction has its payment method defined, its status changes from",Object(i.b)("code",null,"new")," to ",Object(i.b)("code",null,"waiting")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-new-para-waiting.png",target:"_blank",alt:"Exemplo de new para waiting"},"example"),"), that is, the payment method has been selected and is awaiting payment confirmation;")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"When the transaction has the payment confirmed, the status changes from ",Object(i.b)("code",null,"waiting")," to ",Object(i.b)("code",null,"paid")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-waiting-para-paid.png",alt:"Exemplo de waiting para paid",target:"_blank"},"example"),"), that is, payment for the transaction has been confirmed;")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"If the charge does not have its payment confirmed, within 1 (one) calendar day after its due date, its status will change from ",Object(i.b)("code",null,"waiting")," to ",Object(i.b)("code",null,"unpaid")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-waiting-para-unpaid.png",alt:"Exemplo de waiting para unpaid",target:"_blank"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"If the charge has the payment confirmed after the notification sent from ",Object(i.b)("code",null,"unpaid"),", we will send you a new notification with such confirmation, that is, changed status ",Object(i.b)("code",null,"unpaid")," to ",Object(i.b)("code",null,"paid")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-unpaid-para-paid.png",alt:"Exemplo de unpaid para paid",target:"_blank"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"When submitting a request ",Object(i.b)("code",null,"POST")," to the route ",Object(i.b)("code",null,"/charge/:id/link"),", or consume the function ",Object(i.b)("code",null,"linkCharge")," in our SDKs, charge will change the status of ",Object(i.b)("code",null,"new")," to ",Object(i.b)("code",null,"link")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-new-para-link.png",alt:"Exemplo de status new para link",target:"_blank"},"exemplo"),"), and when the payer finalizes the purchase on the Gerencianet payment screen, the status becomes",Object(i.b)("code",null,"waiting")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-link-para-waiting.png",target:"_blank",alt:"Exemplo de status link para waiting"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"If the integrator manually confirms the payment of a transaction, we will send a notification via the API with the status ",Object(i.b)("code",null,"settled")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-waiting-para-settled.png",alt:"Exemplo de status waiting para settled",target:"_blank"},"example"),")."))),Object(i.b)("br",null),Object(i.b)("h2",{id:"status-table-subscriptions"},"Status Table: SUBSCRIPTIONS"),Object(i.b)("p",null,"The following table contains the list of all possible statuses of a subscription:"),Object(i.b)("table",null,Object(i.b)("thead",{parentName:"table"},Object(i.b)("tr",{parentName:"thead"},Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:"center"}),"Description"))),Object(i.b)("tbody",{parentName:"table"},Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"new")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Subscription created, but no charge has been paid.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"active")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Active subscription. All charges are being generated.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"new_charge")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),'Active subscription and generating new transactions. The term "new_charge" appears whenever a new subscription charge is created.')),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"canceled")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Subscription canceled by seller or payer.")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"expired")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Subscription expired. All charges configured for the subscription have already been issued.")))),Object(i.b)("br",null),Object(i.b)("h2",{id:"status-table-carnets"},"Status Table: CARNETS"),Object(i.b)("p",null,"The following table contains the list of all possible statuses of a carnet:"),Object(i.b)("table",null,Object(i.b)("thead",{parentName:"table"},Object(i.b)("tr",{parentName:"thead"},Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:"center"}),"Description"))),Object(i.b)("tbody",{parentName:"table"},Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"up_to_date")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Carn\xea is up to date, there is no delinquent installment. Once the card is created, it also receives this ",Object(i.b)("inlineCode",{parentName:"td"},"up_to_date"),' status. The term "up_to_date" is equivalent to "up to date".')),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"unpaid")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"Carnet is in default. If we identify the default of at least one installment, the status of the booklet is changed to ",Object(i.b)("inlineCode",{parentName:"td"},"unpaid"),'. The term "unpaid" is equivalent to "unpaid".')),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"finished")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),'Carnet is finalized, that is, all installments have been resolved and have a final status. From that moment on, the status of the carnet never changes. The term "finished" is equivalent to "finished".')))),Object(i.b)("p",null,'Every carnet has "status", which is nothing more than the "situation" of the carn\xea. Below, check out some examples with a summary of how the status applicable to carnets and installments work:'),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"As soon as the carnet is created, it receives the status ",Object(i.b)("code",null,"up_to_date")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-up-to-date.png",target:"_blank",alt:"Exemplo status up_to_date"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"If we identify the default of at least one installment, the status of the carnet is changed to ",Object(i.b)("code",null,"unpaid")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-unpaid-carne.png",alt:"Exemplo status unpaid em carn\xea",target:"_blank"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"If we identify the default of at least one installment, the status of the booklet is changed to ",Object(i.b)("code",null,"up_to_date")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo_up_to_date_n-2.png",target:"_blank",alt:"Exemplo status up_to_date em carn\xea"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"When all charges for a carnet are *resolved**, its status changes to ",Object(i.b)("code",null,"finished")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-finished-carne.png",target:"_blank",alt:"Exemplo status finished em carn\xea"},"example"),"). From that moment on, the status of the carnet will no longer be modified;")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"If the integrator marks as paid some installment(s) of a certain carnet (via API or the Gerencianet panel), we will send a notification via the API with the status ",Object(i.b)("code",null,"settled")," (",Object(i.b)("a",{href:"https://gerencianet.com.br/wp-content/uploads/2018/07/exemplo-settled-parcelas-carne.png",target:"_blank",alt:"Exemplo de status settled em parcelas de carn\xea"},"example"),");")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("p",{parentName:"li"},"The carnet identifier is the ",Object(i.b)("code",null,"carnet_id"),",and the identification of the parcels of the carnet is represented by ",Object(i.b)("code",null,"charge_id")," (therefore, the transaction status is applicable to the payment installments)."))),Object(i.b)("p",null,"*",Object(i.b)("em",{parentName:"p"},"Resolved charges"),": By ",Object(i.b)("em",{parentName:"p"},"resolved charge"),", we mean any charge that has reached a final status. It no longer leaves this status except for another status that is also final. Are they:"),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},Object(i.b)("code",null,"paid")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("code",null,"contested")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("code",null,"refunded")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("code",null,"settled")),Object(i.b)("li",{parentName:"ul"},Object(i.b)("code",null,"canceled"))),Object(i.b)("br",null),Object(i.b)("hr",null),Object(i.b)("h3",{id:"examples-of-transaction-status-notifications"},"Examples of TRANSACTION status notifications"),Object(i.b)("p",null,"To see an example of a notification of ",Object(i.b)("strong",{parentName:"p"},"transactions"),', go to the Receiving notifications page and look under the heading "',Object(i.b)("em",{parentName:"p"},"2.1. Examples of responses"),'", in the "',Object(i.b)("em",{parentName:"p"},"Transaction"),'" tab.'),Object(i.b)("br",null),Object(i.b)("h3",{id:"examples-of-subscription-status-notifications"},"Examples of SUBSCRIPTION status notifications"),Object(i.b)("p",null,"To see an example of a ",Object(i.b)("strong",{parentName:"p"},"subscription"),' notification, access the Receiving notifications page and see the heading "',Object(i.b)("em",{parentName:"p"},"2.1. Examples of responses"),'", in the "',Object(i.b)("em",{parentName:"p"},"Subscription"),'" tab.'),Object(i.b)("br",null),Object(i.b)("h3",{id:"examples-of-carnets-status-notifications"},"Examples of CARNETS status notifications"),Object(i.b)("p",null,"To see an example of a ",Object(i.b)("strong",{parentName:"p"},"carnets"),' notification, access the Receiving notifications page and see the title "',Object(i.b)("em",{parentName:"p"},"2.1. Examples of responses"),'", in the "',Object(i.b)("em",{parentName:"p"},"Carn\xea"),'" tab.'),Object(i.b)("br",null),Object(i.b)("h3",{id:"examples-of-payment-link-status-notifications"},"Examples of PAYMENT LINK status notifications"),Object(i.b)("p",null,"To see an example of a ",Object(i.b)("strong",{parentName:"p"},"payment link"),' notification, go to the Receiving notifications page and look under the heading "',Object(i.b)("em",{parentName:"p"},"2.1. Examples of responses"),'", in the "',Object(i.b)("em",{parentName:"p"},"Payment Link"),'" tab.')))}s.isMDXComponent=!0},250:function(e,t,a){"use strict";a.d(t,"a",(function(){return p})),a.d(t,"b",(function(){return u}));var n=a(0),r=a.n(n);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function c(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function b(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?c(Object(a),!0).forEach((function(t){i(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):c(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function l(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=r.a.createContext({}),s=function(e){var t=r.a.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):b(b({},t),e)),a},p=function(e){var t=s(e.components);return r.a.createElement(o.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},m=r.a.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,c=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),p=s(a),m=n,u=p["".concat(c,".").concat(m)]||p[m]||d[m]||i;return a?r.a.createElement(u,b(b({ref:t},o),{},{components:a})):r.a.createElement(u,b({ref:t},o))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,c=new Array(i);c[0]=m;var b={};for(var l in t)hasOwnProperty.call(t,l)&&(b[l]=t[l]);b.originalType=e,b.mdxType="string"==typeof e?e:n,c[1]=b;for(var o=2;o<i;o++)c[o]=a[o];return r.a.createElement.apply(null,c)}return r.a.createElement.apply(null,a)}m.displayName="MDXCreateElement"}}]);