> ## Documentation Index
> Fetch the complete documentation index at: https://requestnetwork-docs-openapi-secure-payments.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get multicall payout state

> Retrieves the passive multicall payout details payload for Secure Payment Page rendering. It does not return quotes, calldata, wallet routes, or execution data.



## OpenAPI

````yaml /api-reference/openapi.v2.json get /v2/secure-payments/multicall-payouts/{token}
openapi: 3.0.0
info:
  title: Request Network API
  description: API for easily creating and paying Requests with Request Network.
  version: 0.13.0
  contact: {}
servers:
  - url: https://api.request.network
    description: Production server
  - url: https://api.stage.request.network
    description: Staging server
  - url: http://127.0.0.1:8080
    description: Local development server
security: []
tags:
  - name: V2/Request
    description: Core payment request operations (V2)
  - name: V2/Payments
    description: Payment search and management operations (V2)
  - name: V2/Payouts
    description: Pay a request without creating one first (V2)
  - name: V2/Payer
    description: Crypto-to-fiat payer management operations (V2)
  - name: V2/Currencies
    description: Currency operations (V2)
  - name: V2/Client IDs
    description: Client ID management (V2)
  - name: V2/Secure Payment
    description: Secure payment operations with token-based access (V2)
  - name: V2/Payee Destination
    description: Payee destination management (V2)
externalDocs:
  description: Request Network Docs
  url: https://docs.request.network/request-network-api
paths:
  /v2/secure-payments/multicall-payouts/{token}:
    get:
      tags:
        - V2/Secure Payment
      summary: Get multicall payout state
      description: >-
        Retrieves the passive multicall payout details payload for Secure
        Payment Page rendering. It does not return quotes, calldata, wallet
        routes, or execution data.
      operationId: SecurePaymentMulticallController_getMulticallPayout_v2
      parameters:
        - name: token
          required: true
          in: path
          description: Multicall payout token returned by the create endpoint
          schema:
            example: 01JZ4PC7EXAMPLEMULTICALL01
            type: string
        - name: Authorization
          in: header
          description: >-
            Bearer token for session authentication (or use session_token
            cookie)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Multicall payout state retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  paymentType:
                    type: string
                    enum:
                      - multicall
                  status:
                    type: string
                    enum:
                      - pending
                      - expired
                      - completed
                      - partially_settled
                  redirectUrl:
                    type: string
                    nullable: true
                  redirectLabel:
                    type: string
                    nullable: true
                  orchestratorId:
                    type: string
                    nullable: true
                  branding:
                    type: object
                    properties:
                      id:
                        type: string
                      clientIdId:
                        type: string
                      orchestratorId:
                        type: string
                      logoPath:
                        type: string
                      pageBackgroundColor:
                        type: string
                      cardBackgroundColor:
                        type: string
                      primaryActionColor:
                        type: string
                      primaryTextColor:
                        type: string
                      secondaryTextColor:
                        type: string
                      termsPath:
                        type: string
                      privacyPath:
                        type: string
                      displayRequestBranding:
                        type: boolean
                    required:
                      - id
                    nullable: true
                  paymentOptions:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: object
                        properties:
                          balance:
                            type: string
                          hasEnoughBalance:
                            type: boolean
                          neededAmount:
                            type: string
                        required:
                          - balance
                          - hasEnoughBalance
                          - neededAmount
                  analytics:
                    type: object
                    properties:
                      creationTimestamp:
                        type: string
                        format: date-time
                      totalPaymentAmountUsd:
                        type: string
                      protocolFeeAmountUsd:
                        type: string
                      orchestratorPayerFeeAmountUsd:
                        type: string
                      orchestratorRecipientFeeAmountUsd:
                        type: string
                      feeAmountsUsdUnavailableReason:
                        type: string
                        enum:
                          - fee_plan_unavailable
                      numberOfPaymentsExcludingFees:
                        type: integer
                        minimum: 0
                      destinationIds:
                        type: array
                        items:
                          type: string
                      payoutKytProvider:
                        type: string
                    description: >-
                      Vendor-neutral analytics metadata that SPP maps into
                      Mixpanel shared properties. Amount values are decimal USD
                      strings to avoid frontend precision loss.
                  requestIds:
                    type: array
                    items:
                      type: string
                    description: Request Network request IDs represented by this payment
                  token:
                    type: string
                    description: Multicall payout token
                  canExecute:
                    type: boolean
                  expiresAt:
                    type: string
                    format: date-time
                  createdAt:
                    type: string
                    format: date-time
                  children:
                    type: array
                    items:
                      type: object
                      properties:
                        securePaymentToken:
                          type: string
                          description: Child secure-payment token
                        requestId:
                          type: string
                          description: Request Network request ID for the child payout
                        position:
                          type: integer
                          minimum: 0
                          description: 0-indexed child order
                        executable:
                          type: boolean
                          description: >-
                            Whether this child can currently be executed in the
                            multicall
                        blockReason:
                          type: string
                          enum:
                            - not_found
                            - not_owned
                            - not_outgoing
                            - not_single_payment
                            - invalid_child_linkage
                            - already_paid
                            - request_processing
                            - secure_payment_expired
                            - secure_payment_not_pending
                            - compliance_failed
                            - not_payable_child
                          description: >-
                            Structured reason when executable is false;
                            otherwise null
                          nullable: true
                        messageKey:
                          type: string
                          description: Stable localized-message key for the block reason
                          nullable: true
                        context:
                          type: object
                          properties:
                            requestId:
                              type: string
                            securePaymentToken:
                              type: string
                            position:
                              type: integer
                              minimum: 0
                            hasBeenPaid:
                              type: boolean
                            securePaymentStatus:
                              type: string
                            requestStatus:
                              type: string
                            expiresAt:
                              type: string
                              format: date-time
                            network:
                              type: string
                            currency:
                              type: string
                          required:
                            - requestId
                            - securePaymentToken
                            - position
                            - hasBeenPaid
                          description: >-
                            Per-child block context used by SPP to render
                            recovery details
                        recoveryAction:
                          type: string
                          enum:
                            - remove_child
                            - recreate_reduced
                            - wait_for_quote_refresh
                            - switch_route
                            - recreate_after_cooldown
                            - support_required
                          description: Suggested recovery action when the child is blocked
                          nullable: true
                        feePlan:
                          type: object
                          properties:
                            version:
                              type: number
                              enum:
                                - 1
                            flow:
                              type: string
                              enum:
                                - get_paid
                                - pay
                            defaultFeeBearer:
                              type: string
                              enum:
                                - payer
                                - payee
                            grossAmountUsd:
                              type: string
                            netRecipientAmountUsd:
                              type: string
                            payerTotalAmountUsd:
                              type: string
                            totalFeesUsd:
                              type: string
                            payeeBorneFeesUsd:
                              type: string
                            payerBorneFeesUsd:
                              type: string
                            fees:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  label:
                                    type: string
                                  feeBearer:
                                    type: string
                                    enum:
                                      - payer
                                      - payee
                                  feeBearerSource:
                                    type: string
                                    enum:
                                      - fee_config
                                      - payment_default_override
                                      - flow_default
                                      - forced_fee_policy
                                  percentageBps:
                                    type: number
                                  capUsd:
                                    type: string
                                    nullable: true
                                  fixedAmountUsd:
                                    type: string
                                    nullable: true
                                  calculatedAmountUsd:
                                    type: string
                                  destinationResolver:
                                    type: string
                                  destinationRef:
                                    type: object
                                    properties:
                                      evmAddress:
                                        type: string
                                      tronAddress:
                                        type: string
                                  configSource:
                                    type: string
                                required:
                                  - type
                                  - label
                                  - feeBearer
                                  - feeBearerSource
                                  - percentageBps
                                  - capUsd
                                  - calculatedAmountUsd
                                  - destinationResolver
                                  - destinationRef
                                  - configSource
                          required:
                            - version
                            - flow
                            - defaultFeeBearer
                            - grossAmountUsd
                            - netRecipientAmountUsd
                            - payerTotalAmountUsd
                            - totalFeesUsd
                            - payeeBorneFeesUsd
                            - payerBorneFeesUsd
                            - fees
                          description: >-
                            Persisted child fee-plan snapshot. Null when fees do
                            not apply or no snapshot exists.
                          nullable: true
                        amount:
                          type: string
                          description: >-
                            Human-readable child amount in the child's payment
                            currency. Null when unavailable.
                          nullable: true
                        payee:
                          type: string
                          description: >-
                            Resolved child recipient address. Null when
                            unavailable.
                          nullable: true
                        reference:
                          type: string
                          description: >-
                            Merchant reference for the child payment. Null when
                            none was provided.
                          nullable: true
                      required:
                        - securePaymentToken
                        - requestId
                        - position
                        - executable
                        - blockReason
                        - messageKey
                        - context
                        - recoveryAction
                        - feePlan
                        - amount
                        - payee
                        - reference
                  totals:
                    type: object
                    properties:
                      childCount:
                        type: integer
                        minimum: 0
                      blockedChildCount:
                        type: integer
                        minimum: 0
                      byDestinationCurrency:
                        type: array
                        items:
                          type: object
                          properties:
                            network:
                              type: string
                            currency:
                              type: string
                            totalAmount:
                              type: string
                          required:
                            - network
                            - currency
                            - totalAmount
                      amountSummary:
                        type: object
                        properties:
                          grossAmount:
                            type: string
                          netRecipientAmount:
                            type: string
                          totalFees:
                            type: string
                          payeeBorneFees:
                            type: string
                          payerBorneFees:
                            type: string
                          payerTotal:
                            type: string
                        required:
                          - grossAmount
                          - netRecipientAmount
                          - totalFees
                          - payeeBorneFees
                          - payerBorneFees
                          - payerTotal
                    required:
                      - childCount
                      - blockedChildCount
                      - byDestinationCurrency
                      - amountSummary
                required:
                  - paymentType
                  - status
                  - redirectUrl
                  - redirectLabel
                  - orchestratorId
                  - branding
                  - analytics
                  - requestIds
                  - token
                  - canExecute
                  - expiresAt
                  - createdAt
                  - children
                  - totals
        '401':
          description: Unauthorized
        '404':
          description: Multicall payout not found
        '429':
          description: Too Many Requests

````