-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): update with transfer api
- Loading branch information
Showing
3 changed files
with
73 additions
and
2 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1994,6 +1994,48 @@ paths: | |
properties: | ||
error: | ||
type: string | ||
/api/v1/transfer: | ||
post: | ||
tags: | ||
- transfer (request access) | ||
summary: Create a Transfer | ||
description: Endpoint to to transfer values between sub accounts | ||
requestBody: | ||
description: Data to create a transfer | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
$ref: '#/components/schemas/TransferCreatePayload' | ||
example: | ||
value: 100 | ||
fromPixKey: [email protected] | ||
toPixKey: [email protected] | ||
responses: | ||
'200': | ||
description: Transfer transaction information | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
properties: | ||
transaction: | ||
$ref: '#/components/schemas/TransferTransaction' | ||
example: | ||
transaction: | ||
value: 100 | ||
time: 2023-06-22T15:33:27.165Z, | ||
correlationID: c782e0ac-833d-4a89-9e73-9b60b2b41d3a | ||
'400': | ||
description: An error message | ||
content: | ||
application/json: | ||
schema: | ||
type: object | ||
properties: | ||
error: | ||
type: string | ||
'/api/v1/webhook/{id}': | ||
delete: | ||
tags: | ||
|
@@ -3145,6 +3187,32 @@ components: | |
$ref: '#/components/schemas/Customer' | ||
type: | ||
type: string | ||
TransferCreatePayload: | ||
type: object | ||
properties: | ||
value: | ||
type: number | ||
description: value of the transfer in cents | ||
fromPixKey: | ||
type: string | ||
description: | ||
the pix key of the account the value of the transfer will come out | ||
from | ||
toPixKey: | ||
type: string | ||
description: the pix key of the account the value of the transfer will go to | ||
TransferTransaction: | ||
type: object | ||
properties: | ||
value: | ||
type: number | ||
description: value of the transaction generated by the transfer | ||
time: | ||
type: string | ||
description: the time the transfer happened | ||
correlationID: | ||
type: string | ||
description: your correlation ID to keep track of this transfer | ||
WebhookPayload: | ||
type: object | ||
properties: | ||
|
@@ -3266,6 +3334,9 @@ tags: | |
- name: transactions | ||
description: | | ||
Endpoint to manage Transactions | ||
- name: transfer (request access) | ||
description: | | ||
Endpoint to transfer values between sub accounts. | ||
- name: webhook | ||
description: | | ||
Endpoint to manage Webhooks |
Large diffs are not rendered by default.
Oops, something went wrong.