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.

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

feat(payment): improve create api docs #805

Merged
merged 1 commit into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 0 additions & 51 deletions docs/payment/payment-how-to-use-api-to-create.md

This file was deleted.

113 changes: 113 additions & 0 deletions docs/payment/payment-how-to-use-api-to-create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
id: payment-how-to-use-api-to-create
sidebar_position: 3
title: Como usar a API de Criar Pagamentos?
tags:
- payment
- api
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## Criando Pagamentos com a API

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)>)
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`.
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.
- **`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.

Num exemplo prático, o body da sua requisição seguiria semelhante a este exemplo:

```mdx-code-block
<Tabs>
<TabItem value="pix-key" label="Usando chave Pix" default>
```

```json
{
"value": 100,
"destinationAlias": "38763885700",
"correlationID": "31ee9576-99ec-412a-9ac7-e142a4a6acf0",
"comment": "um comentário"
}
```

```mdx-code-block
</TabItem>
<TabItem value="qr-code" label="Usando QR Code" default>
```

```json
{
"qrCode": "000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA",
"comment": "payment comment",
"correlationID": "payment1"
}
```

```mdx-code-block
</TabItem>
</Tabs>
```

Após efetuar a requisição, se tudo ocorreu bem, o _status code_ da requisição será `2xx` e no `body` da resposta,
você estará vendo as informações sobre o `payment` recém criado.

Num exemplo, essa será a nossa resposta:

```mdx-code-block
<Tabs>
<TabItem value="pix-key" label="Payload usando chave Pix" default>
```

```json
{
"payment": {
"value": 100,
"status": "CREATED",
"destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
"comment": "payment comment",
"correlationID": "payment1",
"sourceAccountId": "my-source-account-id"
}
}
```

```mdx-code-block
</TabItem>
<TabItem value="qr-code" label="Payload usando QR Code" default>
```

```json
{
"payment": {
"value": 100,
"status": "CREATED",
"destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
"qrCode": "000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA",
"comment": "payment comment",
"correlationID": "payment1",
"sourceAccountId": "my-source-account-id"
}
}
```

```mdx-code-block
</TabItem>
</Tabs>
```

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
id: payment-how-to-use-api-to-create
sidebar_position: 3
title: Como usar a API de Criar Pagamentos?
tags:
- payment
- api
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## Criando Pagamentos com a API

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)>)
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`.
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.
- **`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.

Num exemplo prático, o body da sua requisição seguiria semelhante a este exemplo:

```mdx-code-block
<Tabs>
<TabItem value="pix-key" label="Usando chave Pix" default>
```

```json
{
"value": 100,
"destinationAlias": "38763885700",
"correlationID": "31ee9576-99ec-412a-9ac7-e142a4a6acf0",
"comment": "um comentário"
}
```

```mdx-code-block
</TabItem>
<TabItem value="qr-code" label="Usando QR Code" default>
```

```json
{
"qrCode": "000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA",
"comment": "payment comment",
"correlationID": "payment1"
}
```

```mdx-code-block
</TabItem>
</Tabs>
```

Após efetuar a requisição, se tudo ocorreu bem, o _status code_ da requisição será `2xx` e no `body` da resposta,
você estará vendo as informações sobre o `payment` recém criado.

Num exemplo, essa será a nossa resposta:

```mdx-code-block
<Tabs>
<TabItem value="pix-key" label="Payload usando chave Pix" default>
```

```json
{
"payment": {
"value": 100,
"status": "CREATED",
"destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
"comment": "payment comment",
"correlationID": "payment1",
"sourceAccountId": "my-source-account-id"
}
}
```

```mdx-code-block
</TabItem>
<TabItem value="qr-code" label="Payload usando QR Code" default>
```

```json
{
"payment": {
"value": 100,
"status": "CREATED",
"destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
"qrCode": "000201010212261060014br.gov.bcb.pix2584https://api.openpix.com.br/openpix/testing?transactionID=867ba5173c734202ac659721306b38c952040000530398654040.015802BR5909LOCALHOST6009Sao Paulo62360532867ba5173c734202ac659721306b38c963044BCA",
"comment": "payment comment",
"correlationID": "payment1",
"sourceAccountId": "my-source-account-id"
}
}
```

```mdx-code-block
</TabItem>
</Tabs>
```
2 changes: 1 addition & 1 deletion src/swaggers/openpix.json

Large diffs are not rendered by default.

Loading