Pin Payments API — Charges

naftiko: 1.0.0-alpha2
info:
  label: Pin Payments API — Charges
  description: 'Pin Payments API — Charges. 7 operations. Lead operation: Create a charge. Self-contained Naftiko capability
    covering one Pin Payments business surface.'
  tags:
  - Pin Payments
  - Charges
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PIN_PAYMENTS_API_KEY: PIN_PAYMENTS_API_KEY
capability:
  consumes:
  - type: http
    namespace: pin-payments-charges
    baseUri: https://api.pinpayments.com/1
    description: Pin Payments API — Charges business capability. Self-contained, no shared references.
    resources:
    - name: charges
      path: /charges
      operations:
      - name: post
        method: POST
        description: Create a charge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: get
        method: GET
        description: List charges
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: charges-search
      path: /charges/search
      operations:
      - name: get
        method: GET
        description: Search charges
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: start_date
          in: query
          type: string
        - name: end_date
          in: query
          type: string
        - name: sort
          in: query
          type: string
        - name: direction
          in: query
          type: integer
    - name: charges-verify
      path: /charges/verify
      operations:
      - name: get
        method: GET
        description: Verify a 3D Secure result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session_token
          in: query
          type: string
          required: true
    - name: charges-charge_token
      path: /charges/{charge_token}
      operations:
      - name: get
        method: GET
        description: Retrieve a charge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: charges-charge_token-capture
      path: /charges/{charge_token}/capture
      operations:
      - name: put
        method: PUT
        description: Capture a previously authorized charge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: charges-charge_token-void
      path: /charges/{charge_token}/void
      operations:
      - name: put
        method: PUT
        description: Void an authorized charge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.PIN_PAYMENTS_USER}}'
      password: '{{env.PIN_PAYMENTS_PASS}}'
  exposes:
  - type: rest
    namespace: pin-payments-charges-rest
    port: 8080
    description: REST adapter for Pin Payments API — Charges. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/charges
      name: charges
      description: REST surface for charges.
      operations:
      - method: POST
        name: post
        description: Create a charge
        call: pin-payments-charges.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: List charges
        call: pin-payments-charges.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/charges/search
      name: charges-search
      description: REST surface for charges-search.
      operations:
      - method: GET
        name: get
        description: Search charges
        call: pin-payments-charges.get
        with:
          query: rest.query
          start_date: rest.start_date
          end_date: rest.end_date
          sort: rest.sort
          direction: rest.direction
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/charges/verify
      name: charges-verify
      description: REST surface for charges-verify.
      operations:
      - method: GET
        name: get
        description: Verify a 3D Secure result
        call: pin-payments-charges.get
        with:
          session_token: rest.session_token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/charges/{charge-token}
      name: charges-charge-token
      description: REST surface for charges-charge_token.
      operations:
      - method: GET
        name: get
        description: Retrieve a charge
        call: pin-payments-charges.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/charges/{charge-token}/capture
      name: charges-charge-token-capture
      description: REST surface for charges-charge_token-capture.
      operations:
      - method: PUT
        name: put
        description: Capture a previously authorized charge
        call: pin-payments-charges.put
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/charges/{charge-token}/void
      name: charges-charge-token-void
      description: REST surface for charges-charge_token-void.
      operations:
      - method: PUT
        name: put
        description: Void an authorized charge
        call: pin-payments-charges.put
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pin-payments-charges-mcp
    port: 9090
    transport: http
    description: MCP adapter for Pin Payments API — Charges. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-charge
      description: Create a charge
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: pin-payments-charges.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-charges
      description: List charges
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pin-payments-charges.get
      outputParameters:
      - type: object
        mapping: $.
    - name: search-charges
      description: Search charges
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pin-payments-charges.get
      with:
        query: tools.query
        start_date: tools.start_date
        end_date: tools.end_date
        sort: tools.sort
        direction: tools.direction
      outputParameters:
      - type: object
        mapping: $.
    - name: verify-3d-secure-result
      description: Verify a 3D Secure result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pin-payments-charges.get
      with:
        session_token: tools.session_token
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-charge
      description: Retrieve a charge
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pin-payments-charges.get
      outputParameters:
      - type: object
        mapping: $.
    - name: capture-previously-authorized-charge
      description: Capture a previously authorized charge
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: pin-payments-charges.put
      outputParameters:
      - type: object
        mapping: $.
    - name: void-authorized-charge
      description: Void an authorized charge
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: pin-payments-charges.put
      outputParameters:
      - type: object
        mapping: $.