Western Union Mass Payments API — Payments

naftiko: 1.0.0-alpha2
info:
  label: Western Union Mass Payments API — Payments
  description: 'Western Union Mass Payments API — Payments. 3 operations. Lead operation: List Payments in Batch. Self-contained
    Naftiko capability covering one Western Union business surface.'
  tags:
  - Western Union
  - Payments
  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-payments
    baseUri: https://api.westernunion.com
    description: Western Union Mass Payments API — Payments business capability. Self-contained, no shared references.
    resources:
    - name: customers-clientId-batches-batchId-payments
      path: /customers/{clientId}/batches/{batchId}/payments
      operations:
      - name: listpayments
        method: GET
        description: List Payments in 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.
          required: true
      - name: createpayment
        method: POST
        description: Add Payment to 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 to add the payment to.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: customers-clientId-batches-batchId-payments-paymentId
      path: /customers/{clientId}/batches/{batchId}/payments/{paymentId}
      operations:
      - name: getpayment
        method: GET
        description: Get Payment
        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.
          required: true
        - name: paymentId
          in: path
          type: string
          description: The payment identifier.
          required: true
  exposes:
  - type: rest
    namespace: mass-payments-payments-rest
    port: 8080
    description: REST adapter for Western Union Mass Payments API — Payments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/customers/{clientid}/batches/{batchid}/payments
      name: customers-clientid-batches-batchid-payments
      description: REST surface for customers-clientId-batches-batchId-payments.
      operations:
      - method: GET
        name: listpayments
        description: List Payments in Batch
        call: mass-payments-payments.listpayments
        with:
          clientId: rest.clientId
          batchId: rest.batchId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpayment
        description: Add Payment to Batch
        call: mass-payments-payments.createpayment
        with:
          clientId: rest.clientId
          batchId: rest.batchId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customers/{clientid}/batches/{batchid}/payments/{paymentid}
      name: customers-clientid-batches-batchid-payments-paymentid
      description: REST surface for customers-clientId-batches-batchId-payments-paymentId.
      operations:
      - method: GET
        name: getpayment
        description: Get Payment
        call: mass-payments-payments.getpayment
        with:
          clientId: rest.clientId
          batchId: rest.batchId
          paymentId: rest.paymentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: mass-payments-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Western Union Mass Payments API — Payments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-payments-batch
      description: List Payments in Batch
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mass-payments-payments.listpayments
      with:
        clientId: tools.clientId
        batchId: tools.batchId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-payment-batch
      description: Add Payment to Batch
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mass-payments-payments.createpayment
      with:
        clientId: tools.clientId
        batchId: tools.batchId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-payment
      description: Get Payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mass-payments-payments.getpayment
      with:
        clientId: tools.clientId
        batchId: tools.batchId
        paymentId: tools.paymentId
      outputParameters:
      - type: object
        mapping: $.