Skip to content

Commit

Permalink
feat(docs): update with transfer api
Browse files Browse the repository at this point in the history
  • Loading branch information
Eckzzo committed Jul 10, 2023
1 parent af6e9f8 commit 91cd32a
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/swaggers/openpix.json

Large diffs are not rendered by default.

71 changes: 71 additions & 0 deletions src/swaggers/openpix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion static/openpixPostman.json

Large diffs are not rendered by default.

0 comments on commit 91cd32a

Please sign in to comment.