Skip to content

Commit

Permalink
add description and schema
Browse files Browse the repository at this point in the history
  • Loading branch information
julia-rabello committed Jan 29, 2025
1 parent d9df7ab commit 35a0717
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions VTEX - Payments Gateway API.json
Original file line number Diff line number Diff line change
Expand Up @@ -4080,8 +4080,8 @@
"tags": [
"Payment notification"

Check warning on line 4081 in VTEX - Payments Gateway API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-tag-defined

Operation tags must be defined in global tags.
],
"summary": "Notify payment with payment ID",
"description": "",
"summary": "Send payment notification with payment ID",
"description": "Sends a payment notification for an order based on the payment ID. Used exclusively for manual approval of payments in promissory, boleto, and Pix.\r\n\r\n>ℹ If the payment was made on its creation date and for the full amount, use this endpoint. Otherwise, use the alternative endpoint: `POST` [Notify Payment with payment ID, date, and value paid](https://developers.vtex.com/docs/api-reference/payments-gateway-api#post-/api/payments/pvt/payments/{paymentId}/payment-notification).\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-NotifyPayments | **Payments Notification** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** |\r\n| --------------- | ----------------- |\r\n| Payments Notifier | **Payments Notification** |\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).",
"parameters": [
{
"$ref": "#/components/parameters/paymentId"
Expand Down Expand Up @@ -4113,8 +4113,8 @@
"tags": [
"Payment notification"

Check warning on line 4114 in VTEX - Payments Gateway API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-tag-defined

Operation tags must be defined in global tags.
],
"summary": "Notify payment with payment ID, date and value",
"description": "",
"summary": "Send payment notification with payment ID, date, and value paid",
"description": "Sends a payment notification for an order using the payment ID, including the payment date and the value paid.\r\n\r\nUsed exclusively for manual approval of payments in promissory, boleto, and Pix.\r\n\r\n>ℹ️ This endpoint should only be used when the payment was not completed on its creation date or was partially completed (e.g., $50 out of $100). If the payment was made in full on the creation date, use the `GET` [Send payment notification with payment ID](https://developers.vtex.com/docs/api-reference/payments-gateway-api#get-/api/payments/pvt/payments/{paymentId}/payment-notification) endpoint instead. \r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| PCI Gateway | Payment-NotifyPayments | **Payments Notification** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** |\r\n| --------------- | ----------------- |\r\n| Payments Notifier | **Payments Notification** |\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).",
"parameters": [
{
"$ref": "#/components/parameters/paymentId"
Expand Down Expand Up @@ -7653,6 +7653,24 @@
"description": "Value of the purchase that will be cancelled."
}
}
},
"NotifyPaymentRequest": {
"required": [
"paymentDate",
"valuePaid"
],
"type": "object",
"description": "Payment notification request body information.",
"properties": {
"paymentDate": {

Check warning on line 7665 in VTEX - Payments Gateway API.json

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

request-body-properties-example

Each request body property should have an example. In case the schema is also used as a response and there is already an example elsewhere, feel free to ignore this alert. If you have chosen to include a complete example of the schema to better represent arrays, feel free to ignore this alert.
"type": "string",
"description": "Date when the payment was made, in DD/MM/YYYY format."
},
"valuePaid": {
"type": "number",
"description": "Value that was paid."
}
}
}
},
"parameters": {
Expand Down Expand Up @@ -7710,6 +7728,17 @@
"type": "string",
"example": "A3BDE325F76B4B758B398D900DF06150"
}
},
"paymentId": {
"name": "paymentId",
"in": "path",
"description": "Payment identification.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "B075A551595A43B0AD48DCD8EB481C7F"
}
}
},
"securitySchemes": {
Expand Down

0 comments on commit 35a0717

Please sign in to comment.