Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(payment): improve create api docs #822

Merged
merged 2 commits into from
Feb 7, 2024
Merged

feat(payment): improve create api docs #822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9881163
feat(payment): improve create api docs
fersilva16 Feb 7, 2024
1fb8bdf
Merge branch 'main' into feat/payment
fersilva16 Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/payment/payment-how-to-use-api-to-create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)>)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mixed woovi with openpix

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.
Expand All @@ -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"
}
Expand Down Expand Up @@ -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"
Expand All @@ -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",
Expand Down
9 changes: 7 additions & 2 deletions ...saurus-plugin-content-docs/current/payment/payment-how-to-use-api-to-create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we have each type of pix key here?

- **`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.
Expand All @@ -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"
}
Expand Down Expand Up @@ -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"
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/swaggers/openpix.json
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 19 additions & 3 deletions src/swaggers/openpix.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1400,14 +1400,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
Expand All @@ -1429,6 +1429,7 @@ paths:
value: 100
status: CREATED
destinationAlias: c4249323-b4ca-43f2-8139-8232aab09b93
destinationAliasType: RANDOM
comment: payment comment
correlationID: payment1
sourceAccountId: my-source-account-id
Expand All @@ -1439,7 +1440,9 @@ paths:
value: 100
status: CREATED
destinationAlias: c4249323-b4ca-43f2-8139-8232aab09b93
qrCode: 000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao
destinationAliasType: RANDOM
qrCode:
000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao
Paulo62360532867ba5173c734202ac659721306b38c963044BCA
comment: payment comment
correlationID: payment1
Expand Down Expand Up @@ -3302,6 +3305,7 @@ components:
required:
- value
- destinationAlias
- destinationAliasType
- correlationID
properties:
value:
Expand All @@ -3310,6 +3314,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
Expand Down Expand Up @@ -3348,6 +3361,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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we have each type here?

qrCode:
type: string
description: the QR Code to be paid
Expand Down
2 changes: 1 addition & 1 deletion static/openpixPostman.json
View file
Open in desktop

Large diffs are not rendered by default.