Update API definitions

Author: rebilly-machine-user

openapi/components/requestBodies/PatchPayoutRequestBatch.yaml

@@ -0,0 +1,37 @@
+content:
+  application/json:
+    schema:
+      type: object
+      title: Patch payout request batch
+      properties:
+        description:
+          description: |-
+            Description of the batch.
+            Omit this property when not updating the description.
+            Do not send `null`; use a string value when this property is present.
+          type: string
+          maxLength: 255
+        allocationOrder:
+          description: |-
+            Order for auto-allocation of payout requests in this batch.
+            When set, this field overrides the organization-level allocation order during batch auto-allocation.
+            Must contain `selected-payment-instrument` exactly once.
+            Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
+            Omit this property when not updating the allocation order.
+            Do not send `null`; use an array value when this property is present.
+          type: array
+          items:
+            type: string
+          minItems: 2
+          maxItems: 25
+          uniqueItems: true
+          example:
+            - paypal
+            - Interac-eTransfer
+            - payment-card
+            - alternative-payment-methods
+            - selected-payment-instrument
+description: |-
+  Fields for updating the payout request batch.
+  At least one property must be present.
+  Do not set `description` or `allocationOrder` to `null`.

openapi/components/schemas/Organization.yaml

@@ -250,6 +250,25 @@ properties:
               type: string
               format: email
             default: [ ]
+      payoutRequestAllocationOrder:
+        description: |-
+          Default order for auto-allocation of payout requests.
+          When set, this value is used when a payout request batch does not specify its own allocation order.
+          The order defines which payment instruments are attempted first during auto-allocation.
+          Must contain `selected-payment-instrument` exactly once.
+          Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
+        type:
+          - 'array'
+          - 'null'
+        items:
+          type: string
+        minItems: 2
+        maxItems: 25
+        uniqueItems: true
+        example:
+          - payment-card
+          - alternative-payment-methods
+          - selected-payment-instrument
   taxNumbers:
     type:
       - 'array'

openapi/components/schemas/PayoutRequestBatch.yaml

@@ -72,6 +72,26 @@ properties:
       - 'null'
     maxLength: 255
     example: Batch processed on 2024-01-15
+  allocationOrder:
+    description: |-
+      Order for auto-allocation of payout requests in this batch.
+      When set, this field overrides the organization-level allocation order during batch auto-allocation.
+      Must contain `selected-payment-instrument` exactly once.
+      Valid values: `payment-card` (payment cards), `alternative-payment-methods` (catch-all for alternative payment methods), `selected-payment-instrument` (customer-requested instrument), or any payment method API name (for example, `paypal`, `Interac-eTransfer`).
+    type:
+      - 'array'
+      - 'null'
+    items:
+      type: string
+    minItems: 2
+    maxItems: 25
+    uniqueItems: true
+    example:
+      - paypal
+      - Interac-eTransfer
+      - payment-card
+      - alternative-payment-methods
+      - selected-payment-instrument
   createdTime:
     description: Date and time when the batch was created.
     $ref: ./CreatedTime.yaml

openapi/paths/payout-request-batches@{id}.yaml

@@ -31,4 +31,41 @@ get:
       $ref: ../components/responses/NotFound.yaml
     '429':
       $ref: ../components/responses/TooManyRequests.yaml
+patch:
+  x-badges:
+    - name: Experimental
+  x-products:
+    - Core
+  tags:
+    - Transactions
+  summary: Update a payout request batch
+  operationId: PatchPayoutRequestBatch
+  x-sdk-operation-name: patch
+  description: |-
+    Partially updates a payout request batch with a specified ID.
+    Use this operation to update the description and allocation order.
+  requestBody:
+    $ref: ../components/requestBodies/PatchPayoutRequestBatch.yaml
+  responses:
+    '200':
+      description: Payout request batch updated.
+      headers:
+        X-RateLimit-Limit:
+          $ref: ../components/headers/X-RateLimit-Limit.yaml
+        X-RateLimit-Remaining:
+          $ref: ../components/headers/X-RateLimit-Remaining.yaml
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/PayoutRequestBatch.yaml
+    '401':
+      $ref: ../components/responses/Unauthorized.yaml
+    '403':
+      $ref: ../components/responses/Forbidden.yaml
+    '404':
+      $ref: ../components/responses/NotFound.yaml
+    '422':
+      $ref: ../components/responses/ValidationError.yaml
+    '429':
+      $ref: ../components/responses/TooManyRequests.yaml