update release v2.2.0

_build/api.yaml

@@ -5337,6 +5337,95 @@ paths:
       summary: Get Payout Order
       tags:
       - Payout Orders
+  /payout_orders/{id}/cancel:
+    put:
+      description: Cancel a payout Order resource that corresponds to a payout order
+        ID.
+      operationId: cancelPayoutOrderById
+      parameters:
+      - description: Identifier of the resource
+        example: 6307a60c41de27127515a575
+        in: path
+        name: id
+        required: true
+        schema:
+          type: string
+      - description: Use for knowing which language to use
+        examples:
+          es:
+            summary: for spanish request/response
+            value: es
+          en:
+            summary: for english request/response
+            value: en
+        in: header
+        name: Accept-Language
+        required: false
+        schema:
+          default: es
+          enum:
+          - es
+          - en
+          type: string
+      responses:
+        "200":
+          content:
+            application/vnd.conekta-v2.1.0+json:
+              schema:
+                $ref: '#/components/schemas/payout_order_response'
+          description: successful operation
+        "401":
+          content:
+            application/vnd.conekta-v2.1.0+json:
+              example:
+                details:
+                - message: Please include your access key in your request.
+                  param: null
+                  code: conekta.errors.authentication.missing_key
+                log_id: 507f1f77bcf86cd799439011
+                object: error
+                type: authentication_error
+              schema:
+                $ref: '#/components/schemas/error'
+          description: authentication error
+        "404":
+          content:
+            application/vnd.conekta-v2.1.0+json:
+              example:
+                details:
+                - message: The resource was not found.
+                  param: null
+                  code: conekta.errors.resource_not_found.entity
+                  debug_message: The object Webhook "641b1d5662d7e00001eaa46b" could
+                    not be found.
+                log_id: 641b6c253cd9a50001514fae
+                object: error
+                type: resource_not_found_error
+              schema:
+                $ref: '#/components/schemas/error'
+          description: not found entity
+        "500":
+          content:
+            application/vnd.conekta-v2.1.0+json:
+              example:
+                details:
+                - debug_message: There was a runtime error and Conekta engineers have
+                    been notified.
+                  message: There was a runtime error and Conekta engineers have been
+                    notified.
+                  param: null
+                  code: conekta.errors.api.system.general_failure
+                object: error
+                type: api_error
+                log_id: 641b6f2b3cd9a50001515098
+              schema:
+                $ref: '#/components/schemas/error'
+          description: internal server error
+      security:
+      - bearerAuth: []
+      summary: Cancel Payout Order
+      tags:
+      - Payout Orders
   /checkouts:
     get:
       description: Returns a list of links generated by the merchant
@@ -12293,10 +12382,6 @@ components:
       type: object
     charge_response:
       properties:
-        agreement:
-          description: Agreement ID
-          example: agreement_2tN73UdUSNrYRPD9r
-          type: string
         amount:
           example: 4321
           type: integer
@@ -12347,11 +12432,6 @@ components:
           type: integer
         payment_method:
           $ref: '#/components/schemas/charge_response_payment_method'
-        product_type:
-          description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\
-            \ etc."
-          example: bbva_cash_in
-          type: string
         reference_id:
           description: Reference ID of the charge
           example: ref_2tN73UdUSNrYRPD9r
@@ -14662,6 +14742,10 @@ components:
       - $ref: '#/components/schemas/payment_method'
       - description: use for cash responses
         properties:
+          agreement:
+            description: Agreement ID
+            example: agreement_2tN73UdUSNrYRPD9r
+            type: string
           auth_code:
             example: 542563
             nullable: true
@@ -14680,6 +14764,11 @@ components:
             example: 0
             format: int64
             type: integer
+          product_type:
+            description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\
+              \ etc."
+            example: bbva_cash_in
+            type: string
           service_name:
             example: OxxoPay
             type: string

api.yaml

@@ -82,6 +82,8 @@ paths:
     $ref: "./resources/payout_orders/payout_orders.yml"
   /payout_orders/{id}:
     $ref: "./resources/payout_orders/get_payout_order.yml"
+  /payout_orders/{id}/cancel:
+    $ref: "./resources/payout_orders/cancel_payout_order.yml"
   /checkouts:
     $ref: "./resources/checkouts/checkouts.yml"
   /checkouts/{id}:

resources/payout_orders/cancel_payout_order.yml

@@ -0,0 +1,24 @@
+put:
+  tags:
+    - Payout Orders
+  operationId: cancelPayoutOrderById
+  summary: Cancel Payout Order
+  description: 'Cancel a payout Order resource that corresponds to a payout order ID.'
+  responses:
+    '200':
+      description: successful operation
+      content:
+        application/vnd.conekta-v2.1.0+json:
+          schema:
+            $ref: '../../schemas/payout_orders/payout_order_response.yml'
+    401:
+     $ref: '../errors/401.yml'
+    404:
+     $ref: '../errors/404.yml'
+    500:
+     $ref: '../errors/500.yml'
+  security:
+    - bearerAuth: []
+  parameters:
+    - $ref: '../../parameters/commons/path_param/id.yml'
+    - $ref: '../../parameters/commons/headers/accept_language.yml'

schemas/charges/charge_payment_method_cash_response.yml

@@ -5,6 +5,10 @@ payment_method_cash:
       title: charge_data_payment_method_cash_response
       description: use for cash responses
       properties:
+        agreement:
+          type: string
+          example: "agreement_2tN73UdUSNrYRPD9r"
+          description: "Agreement ID"
         auth_code:
           type: integer
           example: 542563
@@ -23,6 +27,10 @@ payment_method_cash:
           type: integer
           format: int64
           example: 0
+        product_type:
+          type: string
+          example: "bbva_cash_in"
+          description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc."
         service_name:
           type: string
           example: "OxxoPay"

schemas/charges/charge_response.yml

@@ -1,10 +1,6 @@
 title: charges_data_response
 type: object
 properties:
-  agreement:
-    type: string
-    example: "agreement_2tN73UdUSNrYRPD9r"
-    description: "Agreement ID"
   amount: 
     type: integer
     example: 4321
@@ -77,10 +73,6 @@ properties:
         cash_payment: payment_method_cash
         card_payment: payment_method_card
         bank_transfer_payment: payment_method_bank_transfer
-  product_type:
-    type: string
-    example: "bbva_cash_in"
-    description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc."
   reference_id:
     type: string
     description: "Reference ID of the charge"