feat(payment): improve create api docs

Open-Pix · Feb 7, 2024 · 9881163 · 9881163
1 parent 3e9d6af
commit 9881163
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 11 deletions.
diff --git a/docs/payment/payment-how-to-use-api-to-create.mdx b/docs/payment/payment-how-to-use-api-to-create.mdx
@@ -15,18 +15,20 @@ import TabItem from '@theme/TabItem';
 Nós disponibilizamos o _endpoint_ `/api/v1/payment` para que você possa criar
 um novo _payment_ para a respectiva empresa afiliada.
 
-Você pode acessar [aqui](<[https://developers.openpix.com.br/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post](https://developers.openpix.com.br/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post)>)
+Você pode acessar [aqui](<[https://developers.woovi.com/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post](https://developers.woovi.com/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post)>)
 a documentação referente a esse _endpoint_.
 
 Como parte do `body` da requisição, possuímos dois modos de pagamento, por chave Pix e por QR Code:
 
-1. Por chave Pix, esperamos o envio obrigatório dos itens `value`, `destinationAlias` e `correlationID`.
+1. Por chave Pix, esperamos o envio obrigatório dos itens `value`, `destinationAlias`, `destinationAliasType` e `correlationID`.
 2. Por QR Code, esperamos o envio obrigatório dos itens `qrCode` e `correlationID`.
 
 Abaixo temos a descrição de cada campo junto dos opcionais:
 
 - **`value`**: O valor em centavos do pagamento a ser criado.
 - **`destinationAlias`**: A chave pix destinatária do pagamento criado.
+- **`destinationAliasType`**: A tipo da chave pix destinatária do pagamento criado.
+- **`qrCode`**: O QR Code a ser pago
 - **`correlationID`**: Um identificador único para o pagamento.
 - **`comment`**: Comentário que será atrelado a seu pagamento quando a transferencia for realizada.
 - **`sourceAccountId`**: O ID da conta de origem, se não informado será utilizado a conta padrão.
@@ -42,6 +44,7 @@ Num exemplo prático, o body da sua requisição seguiria semelhante a este exem
 {
   "value": 100,
   "destinationAlias": "38763885700",
+  "destinationAliasType": "CPF",
   "correlationID": "31ee9576-99ec-412a-9ac7-e142a4a6acf0",
   "comment": "um comentário"
 }
@@ -81,6 +84,7 @@ Num exemplo, essa será a nossa resposta:
     "value": 100,
     "status": "CREATED",
     "destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
+    "destinationAliasType": "RANDOM",
     "comment": "payment comment",
     "correlationID": "payment1",
     "sourceAccountId": "my-source-account-id"
@@ -99,6 +103,7 @@ Num exemplo, essa será a nossa resposta:
     "value": 100,
     "status": "CREATED",
     "destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
+    "destinationAliasType": "RANDOM",
     "qrCode": "000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA",
     "comment": "payment comment",
     "correlationID": "payment1",

diff --git a/...saurus-plugin-content-docs/current/payment/payment-how-to-use-api-to-create.mdx b/...saurus-plugin-content-docs/current/payment/payment-how-to-use-api-to-create.mdx
@@ -15,18 +15,20 @@ import TabItem from '@theme/TabItem';
 Nós disponibilizamos o _endpoint_ `/api/v1/payment` para que você possa criar
 um novo _payment_ para a respectiva empresa afiliada.
 
-Você pode acessar [aqui](<[https://developers.openpix.com.br/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post](https://developers.openpix.com.br/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post)>)
+Você pode acessar [aqui](<[https://developers.woovi.com/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post](https://developers.woovi.com/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post)>)
 a documentação referente a esse _endpoint_.
 
 Como parte do `body` da requisição, possuímos dois modos de pagamento, por chave Pix e por QR Code:
 
-1. Por chave Pix, esperamos o envio obrigatório dos itens `value`, `destinationAlias` e `correlationID`.
+1. Por chave Pix, esperamos o envio obrigatório dos itens `value`, `destinationAlias`, `destinationAliasType` e `correlationID`.
 2. Por QR Code, esperamos o envio obrigatório dos itens `qrCode` e `correlationID`.
 
 Abaixo temos a descrição de cada campo junto dos opcionais:
 
 - **`value`**: O valor em centavos do pagamento a ser criado.
 - **`destinationAlias`**: A chave pix destinatária do pagamento criado.
+- **`destinationAliasType`**: A tipo da chave pix destinatária do pagamento criado.
+- **`qrCode`**: O QR Code a ser pago
 - **`correlationID`**: Um identificador único para o pagamento.
 - **`comment`**: Comentário que será atrelado a seu pagamento quando a transferencia for realizada.
 - **`sourceAccountId`**: O ID da conta de origem, se não informado será utilizado a conta padrão.
@@ -42,6 +44,7 @@ Num exemplo prático, o body da sua requisição seguiria semelhante a este exem
 {
   "value": 100,
   "destinationAlias": "38763885700",
+  "destinationAliasType": "CPF",
   "correlationID": "31ee9576-99ec-412a-9ac7-e142a4a6acf0",
   "comment": "um comentário"
 }
@@ -81,6 +84,7 @@ Num exemplo, essa será a nossa resposta:
     "value": 100,
     "status": "CREATED",
     "destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
+    "destinationAliasType": "RANDOM",
     "comment": "payment comment",
     "correlationID": "payment1",
     "sourceAccountId": "my-source-account-id"
@@ -99,6 +103,7 @@ Num exemplo, essa será a nossa resposta:
     "value": 100,
     "status": "CREATED",
     "destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
+    "destinationAliasType": "RANDOM",
     "qrCode": "000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA",
     "comment": "payment comment",
     "correlationID": "payment1",

diff --git a/src/swaggers/openpix.json b/src/swaggers/openpix.json
diff --git a/src/swaggers/openpix.yml b/src/swaggers/openpix.yml
@@ -1411,15 +1411,14 @@ paths:
                 value:
                   value: 100
                   destinationAlias: c4249323-b4ca-43f2-8139-8232aab09b93
+                  destinationAliasType: RANDOM
                   comment: payment comment
                   correlationID: payment1
                   sourceAccountId: my-source-account-id
               qrCode:
                 summary: QR Code
                 value:
-                  qrCode:
-                    000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao
-                    Paulo62360532867ba5173c734202ac659721306b38c963044BCA
+                  qrCode: 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009SaoPaulo62360532867ba5173c734202ac659721306b38c963044BCA
                   comment: payment comment
                   correlationID: payment1
                   sourceAccountId: my-source-account-id
@@ -1441,6 +1440,7 @@ paths:
                       value: 100
                       status: CREATED
                       destinationAlias: c4249323-b4ca-43f2-8139-8232aab09b93
+                      destinationAliasType: RANDOM
                       comment: payment comment
                       correlationID: payment1
                       sourceAccountId: my-source-account-id
@@ -1451,6 +1451,7 @@ paths:
                       value: 100
                       status: CREATED
                       destinationAlias: c4249323-b4ca-43f2-8139-8232aab09b93
+                      destinationAliasType: RANDOM
                       qrCode:
                         000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao
                         Paulo62360532867ba5173c734202ac659721306b38c963044BCA
@@ -3343,6 +3344,7 @@ components:
           required:
             - value
             - destinationAlias
+            - destinationAliasType
             - correlationID
           properties:
             value:
@@ -3351,6 +3353,15 @@ components:
             destinationAlias:
               type: string
               description: the pix key the payment should be sent to
+            destinationAliasType:
+              type: string
+              enum:
+                - CPF
+                - CNPJ
+                - EMAIL
+                - PHONE
+                - RANDOM
+              description: the type of the pix key the payment should be sent to
             correlationID:
               type: string
               description: an unique identifier for your payment
@@ -3391,6 +3402,9 @@ components:
         destinationAlias:
           type: string
           description: the pix key the payment should be sent to
+        destinationAliasType:
+          type: string
+          description: the type of the pix key the payment should be sent to
         qrCode:
           type: string
           description: the QR Code to be paid
@@ -3604,9 +3618,9 @@ components:
                 type: string
         dayGenerateCharge:
           type: number
-          description: Day of the month that the charges will be generated. Maximun of 27.
+          description: Day of the month that the charges will be generated. Maximum of 31.
           minimum: 1
-          maximum: 27
+          maximum: 31
           default: 5
         chargeType:
           type: string

diff --git a/static/openpixPostman.json b/static/openpixPostman.json