> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# calling.pay

GET /

Collect a card payment over the phone

Reference: https://signalwire.com/docs/apis/relay/server/calling/calling-pay

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: calling.pay
  version: subpackage_callingPay.calling.pay
  description: Collect a card payment over the phone
channels:
  /:
    description: Collect a card payment over the phone
    publish:
      operationId: subpackage_callingPay.calling.pay-publish
      summary: Server messages
      message:
        oneOf:
          - $ref: >-
              #/components/messages/subpackage_callingPay.calling.pay-server-0-onCallingPayCallPayEvent
          - $ref: >-
              #/components/messages/subpackage_callingPay.calling.pay-server-1-onCallingPayResponse
    subscribe:
      operationId: subpackage_callingPay.calling.pay-subscribe
      summary: calling.pay
      message:
        name: callingPay
        title: calling.pay
        payload:
          $ref: '#/components/schemas/calling.pay_callingPayRequest'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  messages:
    subpackage_callingPay.calling.pay-server-0-onCallingPayCallPayEvent:
      name: onCallingPayCallPayEvent
      title: calling.call.pay
      payload:
        $ref: '#/components/schemas/calling.pay_callPayEvent'
    subpackage_callingPay.calling.pay-server-1-onCallingPayResponse:
      name: onCallingPayResponse
      title: calling.pay response
      payload:
        $ref: '#/components/schemas/calling.pay_callingPayResponse'
  schemas:
    ChannelsCallingPayMessagesCallPayEventJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingPayMessagesCallPayEventJsonrpc
    ChannelsCallingPayMessagesCallPayEventMethod:
      type: string
      enum:
        - signalwire.event
      description: Always `signalwire.event`.
      title: ChannelsCallingPayMessagesCallPayEventMethod
    ChannelsCallingPayMessagesCallPayEventParamsEventType:
      type: string
      enum:
        - calling.call.pay
      description: The event type — identifies which event this is.
      title: ChannelsCallingPayMessagesCallPayEventParamsEventType
    Calling.PayPromptFor:
      type: string
      enum:
        - payment-card-number
        - expiration-date
        - security-code
        - postal-code
        - bank-routing-number
        - bank-account-number
        - payment-processing
        - payment-completed
        - payment-failed
        - payment-canceled
      title: Calling.PayPromptFor
    CallingCallPayParamsFor1:
      type: string
      enum:
        - ''
      title: CallingCallPayParamsFor1
    CallingCallPayParamsFor:
      oneOf:
        - $ref: '#/components/schemas/Calling.PayPromptFor'
        - $ref: '#/components/schemas/CallingCallPayParamsFor1'
      description: >-
        Progress: the field currently being collected, or a lifecycle marker
        (`payment-processing`, `payment-completed`, `payment-failed`,
        `payment-canceled`). Always present on progress events. The
        `bank-routing-number` and `bank-account-number` values never fire, since
        bank-debit is not yet supported.
      title: CallingCallPayParamsFor
    Calling.PayErrorType:
      type: string
      enum:
        - ''
        - timeout
        - invalid-card-number
        - invalid-card-type
        - invalid-date
        - invalid-security-code
        - invalid-postal-code
        - invalid-bank-routing-number
        - invalid-bank-account-number
        - input-matching-failed
        - session-in-progress
        - card-declined
      title: Calling.PayErrorType
    Calling.PayOutcome:
      type: string
      enum:
        - success
        - too-many-failed-attempts
        - payment-connector-error
        - caller-interrupted-with-star
        - relay-pay-stop
        - caller-hung-up
        - validation-error
        - internal-error
      title: Calling.PayOutcome
    Calling.PayMethod:
      type: string
      enum:
        - credit-card
      title: Calling.PayMethod
    Calling.PayCardType:
      type: string
      enum:
        - visa
        - mastercard
        - amex
        - maestro
        - discover
        - jcb
        - diners-club
      title: Calling.PayCardType
    CallingCallPayParamsPaymentCardType1:
      type: string
      enum:
        - ''
      title: CallingCallPayParamsPaymentCardType1
    CallingCallPayParamsPaymentCardType:
      oneOf:
        - $ref: '#/components/schemas/Calling.PayCardType'
        - $ref: '#/components/schemas/CallingCallPayParamsPaymentCardType1'
      description: >-
        Detected card brand. Always present on progress events; an empty string
        until the brand is detected.
      title: CallingCallPayParamsPaymentCardType
    Calling.CallPayParams:
      type: object
      properties:
        node_id:
          type: string
          description: >-
            Opaque identifier that, paired with `call_id`, addresses this call.
            Echo back the value you received; treat it as opaque.
        call_id:
          type: string
          description: Unique identifier of the call.
        control_id:
          type: string
          description: The `control_id` of the pay session this event belongs to.
        status_url:
          type: string
          format: uri
          description: The `status_url` you set on the request, echoed back.
        status_url_method:
          type: string
          description: Always `"POST"`. Present when `status_url` is set.
        for:
          $ref: '#/components/schemas/CallingCallPayParamsFor'
          description: >-
            Progress: the field currently being collected, or a lifecycle marker
            (`payment-processing`, `payment-completed`, `payment-failed`,
            `payment-canceled`). Always present on progress events. The
            `bank-routing-number` and `bank-account-number` values never fire,
            since bank-debit is not yet supported.
        error_type:
          $ref: '#/components/schemas/Calling.PayErrorType'
          description: >-
            Progress: why the most recent collection attempt failed. Always
            present on progress events; an empty string when the attempt didn't
            fail.
        attempt:
          type: string
          description: 'Progress: the current attempt number, as a string.'
        security_code:
          type: string
          description: 'Progress: masked security code collected so far.'
        expiration_date:
          type: string
          description: 'Progress: card expiration date collected so far.'
        result:
          $ref: '#/components/schemas/Calling.PayOutcome'
          description: 'Final: the outcome of the pay session.'
        payment_token:
          type: string
          description: >-
            Final: the token for the payment. When the payment connector created
            a token (for example, a zero-amount tokenization), this is the
            connector's token ID; otherwise it's the requested token type
            (`one-time` or `reusable`).
        payment_confirmation_code:
          type: string
          description: 'Final: the payment connector''s confirmation / charge identifier.'
        payment_error:
          $ref: '#/components/schemas/Calling.PayErrorType'
          description: 'Final: why the payment failed. An empty string when it didn''t fail.'
        payment_error_code:
          type: string
          description: >-
            Final: additional error code for the failure, as a numeric-string
            code (`"700"`–`"706"`), if any.
        payment_connector_error_code:
          type: string
          description: >-
            Final: the payment connector's own error code, if any.
            Connector-defined, so the exact value depends on your payment
            provider.
        payment_connector_error_message:
          type: string
          description: >-
            Final: the payment connector's own error message, if any.
            Connector-defined.
        payment_card_security_code:
          type: string
          description: 'Final: masked security code.'
        payment_card_expiration_date:
          type: string
          description: 'Final: card expiration date.'
        payment_method:
          $ref: '#/components/schemas/Calling.PayMethod'
          description: Payment method being collected. Always present.
        payment_card_number:
          type: string
          description: Masked card number (only the last digits are shown).
        payment_card_type:
          $ref: '#/components/schemas/CallingCallPayParamsPaymentCardType'
          description: >-
            Detected card brand. Always present on progress events; an empty
            string until the brand is detected.
        payment_card_postal_code:
          type: string
          description: Postal code collected with the card.
      required:
        - node_id
        - call_id
        - control_id
      description: >-
        Payload of a `calling.call.pay` event. The event fires repeatedly while
        a pay

        session runs. **Progress** events (as each field is collected) carry
        `for`,

        `error_type`, `attempt`, and the masked data gathered so far. The
        **final**

        event carries `result` and the full masked payment details. Card data is
        always

        masked. Fields are optional because which ones are present depends on
        whether

        this is a progress or final event.
      title: Calling.CallPayParams
    ChannelsCallingPayMessagesCallPayEventParams:
      type: object
      properties:
        event_type:
          $ref: >-
            #/components/schemas/ChannelsCallingPayMessagesCallPayEventParamsEventType
          description: The event type — identifies which event this is.
        event_channel:
          type: string
          description: >-
            The channel the event was delivered on — for Calling events, the
            `protocol`

            string your connection received from `signalwire.connect`.
        timestamp:
          type: number
          format: double
          description: >-
            When the event was emitted, as a Unix timestamp in seconds. Always
            present.
        project_id:
          type: string
          description: >-
            Your project ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        space_id:
          type: string
          description: >-
            Your space ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        params:
          $ref: '#/components/schemas/Calling.CallPayParams'
          description: The event-specific payload.
      required:
        - event_type
        - event_channel
        - timestamp
        - params
      description: The event envelope.
      title: ChannelsCallingPayMessagesCallPayEventParams
    calling.pay_callPayEvent:
      type: object
      properties:
        jsonrpc:
          $ref: '#/components/schemas/ChannelsCallingPayMessagesCallPayEventJsonrpc'
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: >-
            Event id — a unique UUID generated for each event. Events are
            notifications: you do not reply to them.
        method:
          $ref: '#/components/schemas/ChannelsCallingPayMessagesCallPayEventMethod'
          description: Always `signalwire.event`.
        params:
          $ref: '#/components/schemas/ChannelsCallingPayMessagesCallPayEventParams'
          description: The event envelope.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        Fires as a pay session progresses and once more when it completes —
        reporting the field being collected, any errors, and the final masked
        payment details.
      title: calling.pay_callPayEvent
    ChannelsCallingPayMessagesCallingPayResponseJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingPayMessagesCallingPayResponseJsonrpc
    Calling.PayResult:
      type: object
      properties:
        code:
          type: string
          description: >-
            Result code as a string. `"200"` means success. Failures use an
            HTTP-style code

            such as `"400"` (bad request), `"403"`, `"404"` (call not found),
            `"405"`, `"409"`

            (conflict, for example another operation is still running), `"410"`
            (call gone),

            or `"500"`. If the call could not be reached in time, `code` is a
            lowercase error

            identifier instead, such as `response_timeout`, `not_available`, or

            `internal_error`.
        message:
          type: string
          description: >-
            Human-readable description of the result. On failure, it explains
            what went wrong. Always check `code`; `message` may be omitted when
            there is nothing extra to report.
        call_id:
          type: string
          description: The call this result is for, echoed from your request.
        control_id:
          type: string
          description: >-
            Your control identifier for the started action, echoed from your
            request.
      required:
        - code
      title: Calling.PayResult
    JsonRpcErrorCode0:
      type: string
      enum:
        - '-32000'
      title: JsonRpcErrorCode0
    JsonRpcErrorCode1:
      type: string
      enum:
        - '-32001'
      title: JsonRpcErrorCode1
    JsonRpcErrorCode2:
      type: string
      enum:
        - '-32002'
      title: JsonRpcErrorCode2
    JsonRpcErrorCode3:
      type: string
      enum:
        - '-32003'
      title: JsonRpcErrorCode3
    JsonRpcErrorCode4:
      type: string
      enum:
        - '-32004'
      title: JsonRpcErrorCode4
    JsonRpcErrorCode5:
      type: string
      enum:
        - '-32005'
      title: JsonRpcErrorCode5
    JsonRpcErrorCode6:
      type: string
      enum:
        - '-32600'
      title: JsonRpcErrorCode6
    JsonRpcErrorCode7:
      type: string
      enum:
        - '-32601'
      title: JsonRpcErrorCode7
    JsonRpcErrorCode8:
      type: string
      enum:
        - '-32602'
      title: JsonRpcErrorCode8
    JsonRpcErrorCode9:
      type: string
      enum:
        - '-32603'
      title: JsonRpcErrorCode9
    JsonRpcErrorCode10:
      type: string
      enum:
        - '-32700'
      title: JsonRpcErrorCode10
    JsonRpcErrorCode:
      oneOf:
        - $ref: '#/components/schemas/JsonRpcErrorCode0'
        - $ref: '#/components/schemas/JsonRpcErrorCode1'
        - $ref: '#/components/schemas/JsonRpcErrorCode2'
        - $ref: '#/components/schemas/JsonRpcErrorCode3'
        - $ref: '#/components/schemas/JsonRpcErrorCode4'
        - $ref: '#/components/schemas/JsonRpcErrorCode5'
        - $ref: '#/components/schemas/JsonRpcErrorCode6'
        - $ref: '#/components/schemas/JsonRpcErrorCode7'
        - $ref: '#/components/schemas/JsonRpcErrorCode8'
        - $ref: '#/components/schemas/JsonRpcErrorCode9'
        - $ref: '#/components/schemas/JsonRpcErrorCode10'
      title: JsonRpcErrorCode
    JsonRpcError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/JsonRpcErrorCode'
          description: >-
            The error code — a negative integer identifying the failure. See
            `JsonRpcErrorCode` for the full list of values and meanings.
        message:
          type: string
          description: A human-readable description of what went wrong.
        original_request:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            An echo of the request that failed — the full JSON-RPC frame you
            sent

            (`jsonrpc`, `id`, `method`, `params`). Always present.
        requester_nodeid:
          type: string
          description: >-
            The node that sent the failed request. Present only on some routing
            errors.
        requester_identity:
          type: string
          description: >-
            The identity of the requester. Present only on some routing errors;
            same value as `requester_nodeid`.
        responder_nodeid:
          type: string
          description: >-
            The node that was handling the request. Present only on some routing
            errors.
        responder_identity:
          type: string
          description: >-
            The identity of the responder. Present only on some routing errors;
            same value as `responder_nodeid`.
        last_hop_timeout:
          type: boolean
          description: >-
            `true` when the request timed out on its final hop inside
            SignalWire. Present only on some timeout errors.
      required:
        - code
        - message
        - original_request
      description: >-
        A JSON-RPC 2.0 error object, delivered on the `error` field of a
        `JsonRpcResponse` when

        a request fails at the protocol level (bad version, authentication,
        scope, params, or

        your project's connection limit). It replaces `result` — a frame carries
        one or the other, never both.
      title: JsonRpcError
    calling.pay_callingPayResponse:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingPayMessagesCallingPayResponseJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: The id of the request this responds to.
        result:
          $ref: '#/components/schemas/Calling.PayResult'
          description: The method result. Present when the request succeeded.
        error:
          $ref: '#/components/schemas/JsonRpcError'
          description: >-
            Present instead of `result` when the request failed at the protocol
            level.
      required:
        - jsonrpc
        - id
      description: >-
        A JSON-RPC response frame correlated to a request by `id`. On success
        the frame carries

        `result` (the method result). If the request fails at the protocol level
        — an

        incompatible version, failed authentication, insufficient scope, invalid
        params, or your

        project's connection limit — the frame carries `error` instead of
        `result`. Many

        method-level failures (for example most Calling failures) are reported
        the other way: a

        normal `result` whose own `code` is not `"200"`. Each method documents
        which form its

        failures take.


        An `error` returned for `signalwire.connect` is followed by the service
        closing the

        WebSocket; open a new connection to try again. The same happens when

        `signalwire.reauthenticate` sends credentials that are rejected, except
        for a

        Subscriber Access Token. Errors on any other request leave the
        connection open.
      title: calling.pay_callingPayResponse
    ChannelsCallingPayMessagesCallingPayRequestJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsCallingPayMessagesCallingPayRequestJsonrpc
    ChannelsCallingPayMessagesCallingPayRequestMethod:
      type: string
      enum:
        - calling.pay
      description: The name of the JSON-RPC method being invoked.
      title: ChannelsCallingPayMessagesCallingPayRequestMethod
    Calling.PayInput:
      type: string
      enum:
        - dtmf
        - voice
      title: Calling.PayInput
    Calling.PayBankAccountType:
      type: string
      enum:
        - consumer-checking
        - consumer-savings
        - commercial-checking
      title: Calling.PayBankAccountType
    CallingPayParamsTimeout:
      oneOf:
        - type: integer
        - type: string
      description: >-
        Seconds the Pay IVR waits for the next digit before validating the
        captured

        digits, as a number or numeric string (e.g. `6` or `"6"`). Values
        outside

        3–65535 are ignored and the default is used. Default `5`.
      title: CallingPayParamsTimeout
    CallingPayParamsMaxAttempts:
      oneOf:
        - type: integer
        - type: string
      description: >-
        Number of times the Pay IVR retries when collecting card details, as a
        number

        or numeric string (e.g. `3` or `"3"`). Values outside 1–3 are ignored
        and the

        default is used. Default `1`.
      title: CallingPayParamsMaxAttempts
    CallingPayParamsMinPostalCodeLength:
      oneOf:
        - type: integer
        - type: string
      description: >-
        Minimum number of digits a caller must enter for the postal code, as a
        number

        or numeric string (e.g. `6` or `"6"`). Only 1–255 is applied; other
        values

        are ignored. Default `0` (no minimum).
      title: CallingPayParamsMinPostalCodeLength
    Calling.PayTokenType:
      type: string
      enum:
        - one-time
        - reusable
      title: Calling.PayTokenType
    Calling.PayParameter:
      type: object
      properties:
        name:
          type: string
          description: Parameter name.
        value:
          type: string
          description: Parameter value.
      required:
        - name
        - value
      description: >-
        A name/value pair POSTed to the payment connector alongside payment
        details.
      title: Calling.PayParameter
    Calling.PayPromptActionType:
      type: string
      enum:
        - Say
        - Play
      title: Calling.PayPromptActionType
    Calling.PayPromptAction:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Calling.PayPromptActionType'
          description: '`Say` for text-to-speech, `Play` for playing an audio file.'
        phrase:
          type: string
          description: Sentence to speak (for `Say`) or audio URL to play (for `Play`).
      required:
        - type
        - phrase
      description: A single action (Say/Play) executed when a custom prompt is reached.
      title: Calling.PayPromptAction
    CallingPlayMediaType:
      type: string
      enum:
        - audio
        - tts
        - silence
        - ringtone
      title: CallingPlayMediaType
    Calling.PlayMedia:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CallingPlayMediaType'
      required:
        - type
      description: A media element to play. Discriminated on `type`.
      title: Calling.PlayMedia
    Calling.PayPrompt:
      type: object
      properties:
        for:
          $ref: '#/components/schemas/Calling.PayPromptFor'
          description: The situation this prompt applies to.
        card_type:
          type: string
          description: >-
            Space-delimited card-type tokens this prompt applies to (subset of

            `visa mastercard amex maestro discover jcb diners-club`). Applies to
            all

            card types if unset.
        attempt:
          type: string
          description: >-
            Which collection attempt(s) this prompt applies to, as a
            space-delimited list

            of attempt numbers (e.g. `"1 2"`). Applies to all attempts if unset.
        require_matching_inputs:
          type: string
          description: >-
            Whether the caller must enter the same value twice for it to be
            accepted,

            as a string boolean (e.g. `"true"`). Applies to confirmation-style
            prompts.
        error_type:
          type: string
          description: >-
            Space-delimited error-type tokens this prompt applies to. Accepted
            tokens:

            timeout, invalid-card-number, invalid-card-type, invalid-date,

            invalid-security-code, invalid-postal-code, session-in-progress,

            card-declined, invalid-bank-routing-number,
            invalid-bank-account-number,

            and input-matching-failed.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/Calling.PayPromptAction'
          description: Actions to execute for this prompt.
        play:
          type: array
          items:
            $ref: '#/components/schemas/Calling.PlayMedia'
          description: >-
            Media to play for this prompt as an ordered list of audio, TTS,
            silence, or

            ringtone elements (the same shape as `calling.play`). When set, it
            replaces

            `actions` for this prompt. TTS elements that don't set a voice or
            language

            use the request's `voice` and `language`.
      required:
        - for
      description: >-
        A custom prompt that overrides the default the Pay flow uses for a given

        situation. The Pay flow is an interactive voice response (IVR) that
        prompts the

        caller for their card details.


        `card_type` and `error_type` are space-delimited strings, not arrays —
        e.g.

        `error_type: "timeout invalid-card-number invalid-card-type"`.
      title: Calling.PayPrompt
    Calling.PayParams:
      type: object
      properties:
        node_id:
          type: string
          description: >-
            Opaque identifier that, paired with `call_id`, addresses this call.
            Echo back the value you received; treat it as opaque.
        call_id:
          type: string
          description: Unique identifier of the call.
        control_id:
          type: string
          description: >-
            Identifier used to control this active pay (e.g.
            `calling.pay.stop`).
        input:
          $ref: '#/components/schemas/Calling.PayInput'
          default: dtmf
          description: >-
            How payment details are collected. Default `dtmf`. (Only `dtmf`
            supported.)
        status_url:
          type: string
          format: uri
          description: URL to request on each status change during the payment process.
        payment_method:
          $ref: '#/components/schemas/Calling.PayMethod'
          default: credit-card
          description: >-
            Payment method to use. Default `credit-card`. (Only `credit-card`
            supported.)
        bank_account_type:
          $ref: '#/components/schemas/Calling.PayBankAccountType'
          default: consumer-checking
          description: >-
            Bank account type, for bank-debit (ACH) payment flows. Default
            `consumer-checking`. Bank-debit is not yet supported — only
            `credit-card` payments work today.
        timeout:
          $ref: '#/components/schemas/CallingPayParamsTimeout'
          default: 5
          description: >-
            Seconds the Pay IVR waits for the next digit before validating the
            captured

            digits, as a number or numeric string (e.g. `6` or `"6"`). Values
            outside

            3–65535 are ignored and the default is used. Default `5`.
        max_attempts:
          $ref: '#/components/schemas/CallingPayParamsMaxAttempts'
          default: 1
          description: >-
            Number of times the Pay IVR retries when collecting card details, as
            a number

            or numeric string (e.g. `3` or `"3"`). Values outside 1–3 are
            ignored and the

            default is used. Default `1`.
        security_code:
          type: string
          default: 'true'
          description: >-
            Whether to prompt for the card security code, passed as a string
            boolean

            (`"true"` or `"false"`). Default `"true"`.
        postal_code:
          type: string
          default: 'true'
          description: >-
            Whether to prompt for the billing postal code, passed as a string

            (`"true"`, `"false"`, or a known postcode so the IVR skips the
            prompt).

            Default `"true"`.
        min_postal_code_length:
          $ref: '#/components/schemas/CallingPayParamsMinPostalCodeLength'
          default: 0
          description: >-
            Minimum number of digits a caller must enter for the postal code, as
            a number

            or numeric string (e.g. `6` or `"6"`). Only 1–255 is applied; other
            values

            are ignored. Default `0` (no minimum).
        payment_connector_url:
          type: string
          format: uri
          description: >-
            URL that collected payment details are POSTed to upon completion.
            Must be an `https://` URL.
        token_type:
          $ref: '#/components/schemas/Calling.PayTokenType'
          default: reusable
          description: >-
            Whether the payment token is one-off or reusable. Default
            `reusable`.
        charge_amount:
          type: string
          default: '0.00'
          description: >-
            Amount to charge against the payment method. Decimal value with no
            currency

            prefix, passed as a string (e.g. `"15.00"`). Default `"0.00"`.
        currency:
          type: string
          default: usd
          description: Currency of the charge amount. Default `usd`.
        language:
          type: string
          default: en-US
          description: Language for prompts played to the caller. Default `en-US`.
        voice:
          type: string
          default: woman
          description: >-
            Text-to-speech voice for prompts (free-form; passed through to TTS,
            e.g.

            `woman`, `man`, `polly.Sally`). Default `woman`.
        description:
          type: string
          description: Custom description of the payment.
        valid_card_types:
          type: string
          default: visa mastercard amex
          description: >-
            Space-delimited list of card types allowed in this payment, not an
            array —

            subset of `visa mastercard amex maestro discover jcb diners-club`.
            Default

            `"visa mastercard amex"`.
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Calling.PayParameter'
          description: Additional name/value pairs to POST to the payment connector.
        prompts:
          type: array
          items:
            $ref: '#/components/schemas/Calling.PayPrompt'
          description: Custom prompts that override the IVR defaults.
      required:
        - node_id
        - call_id
        - control_id
        - payment_connector_url
      title: Calling.PayParams
    calling.pay_callingPayRequest:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsCallingPayMessagesCallingPayRequestJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: Request id, echoed on the correlated response.
        method:
          $ref: >-
            #/components/schemas/ChannelsCallingPayMessagesCallingPayRequestMethod
          description: The name of the JSON-RPC method being invoked.
        params:
          $ref: '#/components/schemas/Calling.PayParams'
          description: The method's input parameters.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        A JSON-RPC request frame. `Method` is the method name; `Params` is the
        method's input.
      title: calling.pay_callingPayRequest

```