Western Union Mass Payments API — Batches

naftiko: 1.0.0-alpha2
info:
  label: Western Union Mass Payments API — Batches
  description: 'Western Union Mass Payments API — Batches. 3 operations. Lead operation: Get Batch. Self-contained Naftiko
    capability covering one Western Union business surface.'
  tags:
  - Western Union
  - Batches
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WESTERN_UNION_API_KEY: WESTERN_UNION_API_KEY
capability:
  consumes:
  - type: http
    namespace: mass-payments-batches
    baseUri: https://api.westernunion.com
    description: Western Union Mass Payments API — Batches business capability. Self-contained, no shared references.
    resources:
    - name: customers-clientId-batches-batchId
      path: /customers/{clientId}/batches/{batchId}
      operations:
      - name: getbatch
        method: GET
        description: Get Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clientId
          in: path
          type: string
          description: The partner's Western Union client ID.
          required: true
        - name: batchId
          in: path
          type: string
          description: The unique batch identifier.
          required: true
      - name: createbatch
        method: PUT
        description: Create Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clientId
          in: path
          type: string
          description: The partner's Western Union client ID.
          required: true
        - name: batchId
          in: path
          type: string
          description: Partner-assigned batch identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebatch
        method: DELETE
        description: Delete Batch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clientId
          in: path
          type: string
          description: The partner's Western Union client ID.
          required: true
        - name: batchId
          in: path
          type: string
          description: The batch identifier to delete.
          required: true
  exposes:
  - type: rest
    namespace: mass-payments-batches-rest
    port: 8080
    description: REST adapter for Western Union Mass Payments API — Batches. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/customers/{clientid}/batches/{batchid}
      name: customers-clientid-batches-batchid
      description: REST surface for customers-clientId-batches-batchId.
      operations:
      - method: GET
        name: getbatch
        description: Get Batch
        call: mass-payments-batches.getbatch
        with:
          clientId: rest.clientId
          batchId: rest.batchId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createbatch
        description: Create Batch
        call: mass-payments-batches.createbatch
        with:
          clientId: rest.clientId
          batchId: rest.batchId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebatch
        description: Delete Batch
        call: mass-payments-batches.deletebatch
        with:
          clientId: rest.clientId
          batchId: rest.batchId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: mass-payments-batches-mcp
    port: 9090
    transport: http
    description: MCP adapter for Western Union Mass Payments API — Batches. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-batch
      description: Get Batch
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mass-payments-batches.getbatch
      with:
        clientId: tools.clientId
        batchId: tools.batchId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-batch
      description: Create Batch
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: mass-payments-batches.createbatch
      with:
        clientId: tools.clientId
        batchId: tools.batchId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-batch
      description: Delete Batch
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: mass-payments-batches.deletebatch
      with:
        clientId: tools.clientId
        batchId: tools.batchId
      outputParameters:
      - type: object
        mapping: $.