-
Notifications
You must be signed in to change notification settings - Fork 1
/
checkoutDetails.html
503 lines (471 loc) · 27.8 KB
/
checkoutDetails.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>Procedimentos para a integração com o Evoluservices Checkout</title>
<style>
</style>
<link rel="stylesheet" media="screen" href="pub/css/screen.css">
<link rel="stylesheet" media="screen" href="pub/css/screen_overrides.css">
<link rel="stylesheet" media="print" href="pub/css/print.css">
<link rel="stylesheet" media="print" href="pub/css/print_overrides.css">
<link rel="stylesheet" media="screen" href="pub/css/ir-black.css">
<link rel="stylesheet" media="screen" href="pub/css/theme_overrides.css">
<script src="source/javascripts/lib/_jquery.js"></script>
<script src="source/javascripts/lib/_jquery.highlight.js"></script>
<script src="source/javascripts/lib/_lunr.js"></script>
<script src="source/javascripts/lib/_imagesloaded.min.js"></script>
<script src="source/javascripts/lib/_energize.js"></script>
<script src="source/javascripts/app/_lang.js"></script>
<script src="source/javascripts/app/_search.js"></script>
<script src="source/javascripts/app/_toc.js"></script>
<script type="text/javascript">
$(function() {
loadToc($('#toc'), '.toc-link', '.toc-list-h2, .toc-list-h3, .toc-list-h4, .toc-list-h5, .toc-list-h6', 10);
setupLanguages($('body').data('languages'));
$('.content').imagesLoaded( function() {
recacheHeights();
refreshToc();
});
});
window.onpopstate = function() {
activateLanguage(getLanguageFromQueryString());
};
</script>
<meta name="theme-color" content="#F3F7F9" />
<!-- Renderer: Shins v2.4.1-0 -->
</head>
<body data-languages="[]">
<a href="#" id="nav-button">
<span>
NAV
<img src="source/images/navbar.png" class="undefined" alt="Navigation">
</span>
</a>
<div class="toc-wrapper">
<img src="source/images/custom_logo.png" class="logo" alt="Logo">
<div class="search">
<input type="text" class="search" id="input-search" placeholder="Search">
</div>
<ul class="search-results"></ul>
<div id="toc" class="toc-list-h1">
<ul class="toc-list-h1">
<li>
<a href="#procedimentos-para-integra--o-com-evoluservices-checkout" class="toc-h1 toc-link" data-title="Procedimentos para integração com EvoluServices Checkout">Procedimentos para integração com EvoluServices Checkout</a>
</li>
<li>
<a href="#1--consultar-as-op--es-de-pagamento-dispon-veis-para-o-estabelecimento" class="toc-h1 toc-link" data-title="1. Consultar as opções de pagamento disponíveis para o estabelecimento">1. Consultar as opções de pagamento disponíveis para o estabelecimento</a>
</li>
<li>
<a href="#2--realizar-uma-transa--o-parcelada-com-evoluservices-checkout" class="toc-h1 toc-link" data-title="2. Realizar uma transação parcelada com Evoluservices Checkout">2. Realizar uma transação parcelada com Evoluservices Checkout</a>
</li>
<li>
<a href="#3--realizar-uma-transa--o-recorrente-com-evoluservices-checkout" class="toc-h1 toc-link" data-title="3. Realizar uma transação recorrente com Evoluservices Checkout">3. Realizar uma transação recorrente com Evoluservices Checkout</a>
</li>
<li>
<a href="#4--realizar-uma-consulta-de-uma-order-espec-fica" class="toc-h1 toc-link" data-title="4. Realizar uma consulta de uma order específica">4. Realizar uma consulta de uma order específica</a>
</li>
<li>
<a href="#5--cancelar-uma-order-espec-fica" class="toc-h1 toc-link" data-title="5. Cancelar uma order específica">5. Cancelar uma order específica</a>
</li>
</ul>
</div>
<ul class="toc-footer">
<li><a href="index.html">Voltar para a página inicial</a></li>
</ul>
</div>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1 id="procedimentos-para-integra--o-com-evoluservices-checkout">Procedimentos para integração com EvoluServices Checkout</h1>
<p>É possível utilizar a API para que seja usada como checkout. Ou seja, dentro do site ecommerce do parceiro, após o cliente final ter selecionado a ação de pagar, ele será redirecionado para a tela do link de pagamento e após a operação ter sido aprovada, ele será redirecionado para a tela que o parceiro definir.</p>
<p>Abaixo, estão alguns exemplos de caso de uso que poderá ser realizado com a nossa API usando como EvoluServices Checkout.</p>
<p>Para detalhes técnicos, acesse o <a id="learnMoreLink" href="reference.html"> Guia de Referência</a></p>
<h1 id="1--consultar-as-op--es-de-pagamento-dispon-veis-para-o-estabelecimento">1. Consultar as opções de pagamento disponíveis para o estabelecimento</h1>
<blockquote>
<p>Requisição</p>
</blockquote>
<pre class="highlight tab tab-shell"><code>curl -X GET \
<span class="hljs-string">'https://sandbox.evoluservices.com/api/payment-methods?paymentMethods.amount=100.00&paymentMethods.merchantCode=A1B2C3'</span> \
-H <span class="hljs-string">'Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='</span> \
-H <span class="hljs-string">'cache-control: no-cache'</span>
</code></pre>
<blockquote>
<p>Respostas</p>
</blockquote>
<blockquote>
<p>200: Successo</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"paymentMethods"</span>: [
{
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"CREDIT"</span>,
<span class="hljs-attr">"options"</span>: {
<span class="hljs-attr">"maxInstallments"</span>: <span class="hljs-string">"12"</span>,
<span class="hljs-attr">"paymentBrands"</span>: {
<span class="hljs-attr">"value"</span>: [
<span class="hljs-string">"VISA"</span>,
<span class="hljs-string">"MASTER"</span>,
<span class="hljs-string">"ELO"</span>
]
}
}
}
]
}
</code></pre>
<p>Antes de fazer o checkout, é possível conferir os métodos possíveis para criar o link de pagamento de acordo com o valor desejado através do endpoint <a href="./reference.html#paymentmethods">/api/paymentMethods</a>.</p>
<p>Os métodos possíveis se referem as opções de crédito e recorrente (<code>type</code>). Além disso, mostrará informações como as bandeiras disponíveis para realizar a transação (<code>paymentBrands</code>) e a quantidade máxima de parcelas possível para aquele valor (<code>maxInstallments</code>). No caso, a quantidade máxima de parcelas se refere apenas para a transação de crédito.</p>
<h1 id="2--realizar-uma-transa--o-parcelada-com-evoluservices-checkout">2. Realizar uma transação parcelada com Evoluservices Checkout</h1>
<blockquote>
<p><strong>Criar link de pagamento</strong></p>
</blockquote>
<blockquote>
<p>Requisição</p>
</blockquote>
<pre class="highlight tab tab-shell"><code>curl -X POST \
<span class="hljs-string">'https://sandbox.evoluservices.com/api/orders'</span> \
-H <span class="hljs-string">'Content-Type: application/json'</span> \
-H <span class="hljs-string">'Authorization: Basic b3JkZXJzOjEyM211ZGFy'</span> \
-H <span class="hljs-string">'cache-control: no-cache'</span> \
-d <span class="hljs-string">'{
"order":{
"reference": "123CLIENTS",
"redirectUrl": "https://example.com/callback",
"amount": "10000.00",
"maxInstallments": "2",
"minInstallments": "1",
"merchantCode": "A1B2C3",
"customerName": "Rodrigo",
"customerDocument": "01234567890",
"recurrent": false,
"description": "Venda de equipamento efetuada na data 22/06/2020",
"expirationDate": "2020-07-16"
}
}'</span>
</code></pre>
<blockquote>
<p>Respostas</p>
</blockquote>
<blockquote>
<p>200: Retorno com UUID para checkout</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"e2ba235d-0b30-4edc-981d-e2c222763aee"</span>,
<span class="hljs-attr">"payUrl"</span>: <span class="hljs-string">"sandbox.evoluservices.com/api/orders/e2ba235d-0b30-4edc-981d-e2c222763aee/pay"</span>,
<span class="hljs-attr">"reference"</span>: <span class="hljs-string">"123CLIENTS"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"PENDING"</span>
}
</code></pre>
<blockquote>
<p><strong>Fazer Checkout</strong></p>
</blockquote>
<pre class="highlight tab tab-shell"><code>Com seu navegador, acesse
<span class="hljs-string">'https://sandbox.evoluservices.com/orders/e2ba235d-0b30-4edc-981d-e2c222763aee/pay'</span>
</code></pre>
<p>Tendo o conhecimento dos métodos disponíveis para fazer o checkout, basta utilizar o endpoint <a href="./reference.html#createorders">/api/orders</a> com o body devidamente preenchido. Como desejamos fazer um checkout para uma transação de crédito, o campo <code>recurrent</code> deve ter o valor <code>false</code> e os campos <code>recurrentType</code>, <code>quantityCharges</code> e <code>frequency</code> não serão considerados.</p>
<p>A resposta dessa requisição será o <a href="./reference.html#tocs_clientsorderoutputdto">ClientOrderOutpuDto</a>, onde será possível encontrar a <code>uuid</code> que deve ser redirecionado ao pagador para que a página seja redirecionada através da URL <code>https://sandbox.evoluservices.com/orders/{uuid}/pay</code>.</p>
<p>Após o pagamento ser aprovado, o pagador será redirecionado para o endereço que for definido no campo <code>redirectUrl</code>.</p>
<h1 id="3--realizar-uma-transa--o-recorrente-com-evoluservices-checkout">3. Realizar uma transação recorrente com Evoluservices Checkout</h1>
<blockquote>
<p><strong>Realizar transação recorrente do link de pagamento</strong></p>
</blockquote>
<blockquote>
<p>Requisição: Recorrência mensal</p>
</blockquote>
<pre class="highlight tab tab-shell"><code>curl -X POST \
<span class="hljs-string">'https://sandbox.evoluservices.com/api/orders'</span> \
-H <span class="hljs-string">'Content-Type: application/json'</span> \
-H <span class="hljs-string">'Authorization: Basic b3JkZXJzOjEyM211ZGFy'</span> \
-H <span class="hljs-string">'cache-control: no-cache'</span> \
-d <span class="hljs-string">'{
"order":{
"reference": "123CLIENTS",
"redirectUrl": "https://example.com/callback",
"amount": "10000.00",
"maxInstallments": "2",
"merchantCode": "A1B2C3",
"customerName": "Rodrigo",
"customerDocument": "01234567890",
"recurrent": true,
"recurrenceType": "MONTHLY",
"quantityCharges"10",
"description": "Venda de equipamento efetuada na data 22/06/2020",
"expirationDate": "2020-07-16"
}
}'</span>
</code></pre>
<blockquote>
<p>Requisição: Recorrência flexível</p>
</blockquote>
<pre class="highlight tab tab-shell"><code>curl -X POST \
<span class="hljs-string">'https://sandbox.evoluservices.com/api/orders'</span> \
-H <span class="hljs-string">'Content-Type: application/json'</span> \
-H <span class="hljs-string">'Authorization: Basic b3JkZXJzOjEyM211ZGFy'</span> \
-H <span class="hljs-string">'cache-control: no-cache'</span> \
-d <span class="hljs-string">'{
"order":{
"reference": "123CLIENTS",
"redirectUrl": "https://example.com/callback",
"amount": "10000.00",
"maxInstallments": "2",
"merchantCode": "A1B2C3",
"customerName": "Rodrigo",
"customerDocument": "01234567890",
"recurrent": true,
"recurrenceType": "FLEXIBLE",
"quantityCharges: "10",
"frequency": "21",
"description": "Venda de equipamento efetuada na data 22/06/2020",
"expirationDate": "2020-07-16"
}
}'</span>
</code></pre>
<blockquote>
<p>Respostas</p>
</blockquote>
<blockquote>
<p>200: Retorno com UUID para checkout</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"e2ba235d-0b30-4edc-981d-e2c222763aee"</span>,
<span class="hljs-attr">"payUrl"</span>: <span class="hljs-string">"sandbox.evoluservices.com/api/orders/e2ba235d-0b30-4edc-981d-e2c222763aee/pay"</span>,
<span class="hljs-attr">"reference"</span>: <span class="hljs-string">"123CLIENTS"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"PENDING"</span>
}
</code></pre>
<blockquote>
<p><strong>Fazer Checkout</strong></p>
</blockquote>
<pre class="highlight tab tab-shell"><code>Com seu navegador, acesse
<span class="hljs-string">'https://sandbox.evoluservices.com/orders/e2ba235d-0b30-4edc-981d-e2c222763aee/pay'</span>
</code></pre>
<p>Para fazer o checkout para uma transação recorrente, basta preencher o body no <a href="./reference.html#createorders">/api/orders</a> com as informações corretas. Neste caso, o que será diferente do caso anterior será que o campo <code>recurrent</code> agora será <code>true</code> e consequentemente alguns campos serão obrigatórios, como<br>
<code>recurrentType</code>, <code>quantityCharges</code> e <code>frequency</code>.</p>
<p>Como o campo <code>recurrent</code> será <code>true</code>, o campo <code>maxInstallments</code> será desconsiderado.</p>
<p>Com relação ao campo <code>recurrentType</code>, ele pode ter como valor <code>MONTHLY</code> ou <code>FLEXIBLE</code>. No caso de ser escolhido a opção <code>MONTHLY</code>, o que estiver no campo <code>frequency</code> não será considerado. E caso a opção <code>FLEXIBLE</code> seja escolhida, o campo <code>frequency</code> deve ser preenchido com o número de dias em que as transações serão intervaladas. E por último, o campo <code>quantityCharges</code> se refere à quantidade de vezes em que essa recorrência de transação ocorrerá.</p>
<p>A partir daqui, a sequência será a mesmo do caso de um link de pagamento de uma transação de crédito. Será recebido como resposta o <a href="./reference.html#tocs_clientsorderoutputdto">ClientOrderOutpuDto</a> com as informações do checkout em questão, inclusive a <code>uuid</code> e poderá fazer o redirecionamento de página através da URL <code>sandbox.evoluservices.com/orders/{uuid}/pay</code>.</p>
<h1 id="4--realizar-uma-consulta-de-uma-order-espec-fica">4. Realizar uma consulta de uma order específica</h1>
<blockquote>
<p><strong>Consultar uma order específica</strong></p>
</blockquote>
<blockquote>
<p>Requisição</p>
</blockquote>
<pre class="highlight tab tab-shell"><code>curl -X GET \
<span class="hljs-string">'http://sandbox.evoluservices.com/api/orders/e2ba235d-0b30-4edc-981d-e2c222763aee'</span> \
-H <span class="hljs-string">'Authorization: Basic b3JkZXJzOjEyM211ZGFy'</span> \
-H <span class="hljs-string">'cache-control: no-cache'</span>
</code></pre>
<blockquote>
<p>Resposta</p>
</blockquote>
<blockquote>
<p>200: Transação aprovada</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"e2ba235d-0b30-4edc-981d-e2c222763aee"</span>,
<span class="hljs-attr">"reference"</span>: <span class="hljs-string">"123CLIENTS"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"APPROVED"</span>,
<span class="hljs-attr">"expirationDate"</span>: <span class="hljs-string">"2020-07-16"</span>,
<span class="hljs-attr">"transactionList"</span>: [
{
<span class="hljs-attr">"number"</span>: <span class="hljs-string">"12345678909"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"APPROVED"</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"100.00"</span>,
<span class="hljs-attr">"installments"</span>: <span class="hljs-string">"2"</span>,
<span class="hljs-attr">"paymentBrand"</span>: <span class="hljs-string">"VISA_CREDITO"</span>,
<span class="hljs-attr">"paymentQuantity"</span>: <span class="hljs-string">"1"</span>,
<span class="hljs-attr">"nsu"</span>: <span class="hljs-string">"993485982"</span>,
<span class="hljs-attr">"authorizationNumber"</span>: <span class="hljs-string">"470216"</span>,
<span class="hljs-attr">"customer"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Jose da Silva"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"012.345.678-90"</span>
},
<span class="hljs-attr">"payments"</span>: [
{
<span class="hljs-attr">"number"</span>: <span class="hljs-string">"12345678909"</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"100.00"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"PAYED"</span>,
<span class="hljs-attr">"payDate"</span>: <span class="hljs-string">"01/01/2001"</span>,
<span class="hljs-attr">"merchant"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Marcelo Pereira"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"123.456.789-09"</span>
}
}
]
}
]
}
</code></pre>
<blockquote>
<p>200: Transação reprovada</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"bf91138e-050c-4f15-bf4a-cfb0dbdeba8e"</span>,
<span class="hljs-attr">"reference"</span>: <span class="hljs-string">"123CLIENTS"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"PENDING"</span>,
<span class="hljs-attr">"expirationDate"</span>: <span class="hljs-string">"2021-06-30"</span>,
<span class="hljs-attr">"transactionList"</span>: [
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">855021062300001</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"DISAPPROVED"</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"333.33"</span>,
<span class="hljs-attr">"installments"</span>: <span class="hljs-number">3</span>,
<span class="hljs-attr">"paymentBrand"</span>: <span class="hljs-string">"VISA_CREDITO"</span>,
<span class="hljs-attr">"paymentQuantity"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"customer"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Jose da Silva"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"57116662073"</span>
},
<span class="hljs-attr">"payments"</span>: []
}
]
}
</code></pre>
<blockquote>
<p>200: Link pendente, sem transações</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"e2ba235d-0b30-4edc-981d-e2c222763aee"</span>,
<span class="hljs-attr">"reference"</span>: <span class="hljs-string">"123CLIENTS"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"PENDING"</span>,
<span class="hljs-attr">"transactionList"</span>: []
}
</code></pre>
<blockquote>
<p>200: Link com primeira transação incompleta (erro). Segunda transação aprovada e ha pagamentos para fornecedores.</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"uuid"</span>: <span class="hljs-string">"7d2434d6-4fd8-46e5-abc2-7cc02360c046"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"APPROVED"</span>,
<span class="hljs-attr">"expirationDate"</span>: <span class="hljs-string">"2021-08-19"</span>,
<span class="hljs-attr">"transactionList"</span>: [
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">857321081700107</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"APPROVED"</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"1000.00"</span>,
<span class="hljs-attr">"installments"</span>: <span class="hljs-number">2</span>,
<span class="hljs-attr">"paymentBrand"</span>: <span class="hljs-string">"VISA_CREDITO"</span>,
<span class="hljs-attr">"paymentQuantity"</span>: <span class="hljs-number">4</span>,
<span class="hljs-attr">"nsu"</span>: <span class="hljs-string">"721808"</span>,
<span class="hljs-attr">"authorizationNumber"</span>: <span class="hljs-string">"789631"</span>,
<span class="hljs-attr">"customer"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Maria Silva"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"01234567890"</span>
},
<span class="hljs-attr">"payments"</span>: [
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">1</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"452.00"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"UNPAID"</span>,
<span class="hljs-attr">"payDate"</span>: <span class="hljs-string">"17/09/2021"</span>,
<span class="hljs-attr">"merchant"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Clínica Dentista"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"01234567890"</span>
}
},
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">2</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"452.00"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"UNPAID"</span>,
<span class="hljs-attr">"payDate"</span>: <span class="hljs-string">"18/10/2021"</span>,
<span class="hljs-attr">"merchant"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Clínica Dentista"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"01234567890"</span>
}
},
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">1</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"30.00"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"UNPAID"</span>,
<span class="hljs-attr">"payDate"</span>: <span class="hljs-string">"17/09/2021"</span>,
<span class="hljs-attr">"merchant"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Fornecedor Raios-x"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"33086046716"</span>
}
},
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">2</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"30.00"</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"UNPAID"</span>,
<span class="hljs-attr">"payDate"</span>: <span class="hljs-string">"18/10/2021"</span>,
<span class="hljs-attr">"merchant"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Fornecedor Raios-x"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"33086046716"</span>
}
}
]
},
{
<span class="hljs-attr">"number"</span>: <span class="hljs-number">856021081200107</span>,
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"PENDING_APPROVAL"</span>,
<span class="hljs-attr">"amount"</span>: <span class="hljs-string">"1000.00"</span>,
<span class="hljs-attr">"installments"</span>: <span class="hljs-number">12</span>,
<span class="hljs-attr">"paymentBrand"</span>: <span class="hljs-string">"VISA_CREDITO"</span>,
<span class="hljs-attr">"paymentQuantity"</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">"customer"</span>: {
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Pedro Costa"</span>,
<span class="hljs-attr">"document"</span>: <span class="hljs-string">"01234567890"</span>
},
<span class="hljs-attr">"payments"</span>: []
}
]
}
</code></pre>
<p>Como comentado, é possível realizar consultas de checkout específicos a qualquer momento. Para realizar tal operação, basta utilizar o <a href="./reference.html#consultorder">/api/orders/{uuid}</a> com o uuid do checkout desejado.</p>
<p>Caso a transação de chekcout ainda esteja com o pagamento pendente, a resposta será a <a href="./reference.html#tocs_clientsordertransactionsdto">ClientOrderOutpuDto</a> com <code>status</code> como <code>PENDING</code>.</p>
<p>Caso tenha ocorrido alguma tentativa da transação ser realizada, cada tentativa irá gerar um <a href="./reference.html#tocs_clientstransactiondto">ClientTransactionOutpuDto</a> com o <code>status</code> adequado referente a cada tentativa dentro da resposta. Na transação que for de fato aprovada, <code>payments</code> estará preenchido com as informações dos pagamentos referente à liquidação dessa transação. O campo <code>payDate</code> se refere ao dia do pagamento, sendo que se o pagamento já tiver sido realizado, a data será a do dia da liquidação, e se ele ainda não foi realizado, é a data prevista de pagamento.</p>
<h1 id="5--cancelar-uma-order-espec-fica">5. Cancelar uma order específica</h1>
<blockquote>
<p><strong>Cancelar uma order específica</strong></p>
</blockquote>
<blockquote>
<p>Requisição</p>
</blockquote>
<pre class="highlight tab tab-shell"><code>curl -X DELETE \
<span class="hljs-string">'https://sandbox.evoluservices.com/api/orders/e2ba235d-0b30-4edc-981d-e2c222763aee'</span> \
-H <span class="hljs-string">'Authorization: Basic b3JkZXJzOjEyM211ZGFy'</span>
</code></pre>
<blockquote>
<p>Respostas</p>
</blockquote>
<blockquote>
<p>200: Cancelamento realizado com sucesso</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"success"</span>: <span class="hljs-string">"true"</span>,
<span class="hljs-attr">"error"</span>: <span class="hljs-string">"OK_MSG"</span>
}
</code></pre>
<blockquote>
<p>500: Status da order inválido para cancelamento</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"success"</span>: <span class="hljs-string">"false"</span>,
<span class="hljs-attr">"error"</span>: <span class="hljs-string">"ORDER_STATUS_INVALID_FOR_CANCELLATION"</span>
}
</code></pre>
<blockquote>
<p>404: Order não encontrada a partir do uuid fornecido</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"success"</span>: <span class="hljs-string">"false"</span>,
<span class="hljs-attr">"error"</span>: <span class="hljs-string">"ORDER_NOT_FOUND"</span>
}
</code></pre>
<p>Para efetuar o cancelamento de uma order e assim impossibilitar o pagamento e reenvio de notificações dela, utilize <a href="./reference.html#cancelorder">/api/orders/{uuid}</a> com o uuid relacionado ao Link de Pagamento que deverá ser cancelado.</p>
<p>Caso o <code>status</code> atual da order seja <code>PENDING</code>, ele será alterado para <code>CANCELED</code> e o Link será cancelado.</p>
<p>Caso o <code>status</code> atual seja diferente de <code>PENDING</code> (já tenha <code>status</code> como <code>CANCELED</code> ou <code>APPROVED</code>, por exemplo), a order não sofrerá alterações.</p>
<p>Lembre-se que orders com <code>status</code> como <code>CANCELED</code> <strong>não podem ser reativadas</strong>, portanto uma nova order deverá ser criada, caso seja necessário.</p>
<!-- Renderer: Shins v2.4.1-0 -->
</div>
<div class="dark-box">
<div class="lang-selector">
</div>
</div>
</div>
</body>
</html>