> ## Documentation Index > Fetch the complete documentation index at: https://docs.walletconnect.com/llms.txt > Use this file to discover all available pages before exploring further. # Get payment options > This endpoint takes a list of accounts and returns a list of options that can be used to complete the payment. ## OpenAPI ````yaml api/2026-02-19.preview.json POST /v1/gateway/payment/{id}/options openapi: 3.1.0 info: title: WalletConnect Pay API version: 2026-02-19.preview servers: - url: https://api.pay.walletconnect.com security: - API Key: [] - ApiKey: [] - AppId: [] tags: - name: Gateway - name: Payments - name: Refunds - name: Merchant Management - name: Settlements - name: Crypto Settlement paths: /v1/gateway/payment/{id}/options: post: tags: - Gateway summary: Get payment options description: >- This endpoint takes a list of accounts and returns a list of options that can be used to complete the payment. operationId: gatewayGetPaymentOptions parameters: - name: Api-Key in: header required: false schema: type: - string - 'null' - name: App-Id in: header required: false schema: type: - string - 'null' - name: Client-Id in: header required: false schema: type: - string - 'null' - name: WCP-Version in: header required: false schema: type: - string - 'null' - name: Sdk-Name in: header required: false schema: type: - string - 'null' - name: Sdk-Version in: header required: false schema: type: - string - 'null' - name: Sdk-Platform in: header required: false schema: type: - string - 'null' - name: id in: path description: Payment ID required: true schema: $ref: '#/components/schemas/PaymentId' - name: includePaymentInfo in: query description: Whether to include payment information in the response required: false schema: type: - boolean - 'null' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetPaymentOptionsRequest' required: true responses: '200': description: Payment options retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetPaymentOptionsResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Payment not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: PaymentId: type: string description: Payment ID examples: - pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV GetPaymentOptionsRequest: type: object required: - accounts properties: accounts: type: array items: type: string refresh: type: - array - 'null' items: type: string example: accounts: - eip155:8453:0x123 refresh: null GetPaymentOptionsResponse: type: object properties: collectData: oneOf: - type: 'null' - $ref: '#/components/schemas/CollectData' info: oneOf: - type: 'null' - $ref: '#/components/schemas/GetPaymentResponse' options: type: - array - 'null' items: $ref: '#/components/schemas/PaymentOption' example: collectData: fields: - id: fullName name: Full name required: true type: text - id: dob name: Date of birth required: true type: date schema: $schema: https://json-schema.org/draft/2020-12/schema additionalProperties: false anyOf: - required: - pobCountry - pobAddress - required: - porCountry - porAddress properties: dob: description: Date of birth in YYYY-MM-DD format format: date title: Date of Birth type: string fullName: description: User's full legal name minLength: 1 title: Full Name type: string pobAddress: description: Place of birth city and state (e.g., 'New York, NY') maxLength: 200 title: Place of Birth Address type: string pobCountry: description: Place of birth country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Birth Country type: string porAddress: description: Place of residence street address, city, and state maxLength: 200 title: Place of Residence Address type: string porCountry: description: Place of residence country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Residence Country type: string tosConfirmed: const: true description: Must be true to confirm Terms of Service acceptance title: Terms of Service Confirmation type: boolean required: - fullName - dob - tosConfirmed type: object url: >- https://data-collection.walletconnect.com/ic/pay_123?accounts=eip155:1:0x123 info: amount: display: assetName: USD Coin assetSymbol: USDC decimals: 6 iconUrl: https://assets.walletconnect.com/usdc.png networkIconUrl: https://assets.walletconnect.com/base.png networkName: Base unit: >- caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000 value: '1000000' buyer: accountCaip10: eip155:1:0x0000000000000000000000000000000000000000 accountProviderIcon: https://example.com/icon.png accountProviderName: Wallet expiresAt: 1700000000 merchant: iconUrl: https://example.com/icon.png name: Merchant status: requires_action options: - account: eip155:1:0x0000000000000000000000000000000000000000 actions: - data: chain_id: eip155:8453 method: eth_signTypedData_v4 params: - '0x0000000000000000000000000000000000000000' - >- {"domain":{"name":"USD Coin","version":"2","chainId":"0x2105","verifyingContract":"0x0000000000000000000000000000000000000000"},"types":{"EIP712Domain":[{"type":"string","name":"name"},{"type":"string","name":"version"},{"type":"uint256","name":"chainId"},{"type":"address","name":"verifyingContract"}],"ReceiveWithAuthorization":[{"type":"address","name":"from"},{"type":"address","name":"to"},{"type":"uint256","name":"value"},{"type":"uint256","name":"validAfter"},{"type":"uint256","name":"validBefore"},{"type":"bytes32","name":"nonce"}]},"primaryType":"ReceiveWithAuthorization","message":{"from":"0x0000000000000000000000000000000000000000","nonce":"0x0000000000000000000000000000000000000000000000000000000000000000","to":"0x0000000000000000000000000000000000000000","validAfter":"0x0","validBefore":"0x0","value":"0x0"}} type: walletRpc amount: display: assetName: USD Coin assetSymbol: USDC decimals: 6 iconUrl: https://assets.walletconnect.com/usdc.png networkIconUrl: https://assets.walletconnect.com/base.png networkName: Base unit: >- caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000 value: '1000000' collectData: fields: - id: fullName name: Full name required: true type: text - id: dob name: Date of birth required: true type: date schema: $schema: https://json-schema.org/draft/2020-12/schema additionalProperties: false anyOf: - required: - pobCountry - pobAddress - required: - porCountry - porAddress properties: dob: description: Date of birth in YYYY-MM-DD format format: date title: Date of Birth type: string fullName: description: User's full legal name minLength: 1 title: Full Name type: string pobAddress: description: Place of birth city and state (e.g., 'New York, NY') maxLength: 200 title: Place of Birth Address type: string pobCountry: description: Place of birth country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Birth Country type: string porAddress: description: Place of residence street address, city, and state maxLength: 200 title: Place of Residence Address type: string porCountry: description: Place of residence country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Residence Country type: string tosConfirmed: const: true description: Must be true to confirm Terms of Service acceptance title: Terms of Service Confirmation type: boolean required: - fullName - dob - tosConfirmed type: object url: >- https://data-collection.walletconnect.com/ic/pay_123?accounts=eip155:1:0x123 etaS: 5 expiresAt: 1700000300 id: opt_123 ErrorResponse: type: object description: Standard error response structure for API errors. required: - code - message properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string CollectData: type: object required: - fields - schema - url properties: fields: type: array items: $ref: '#/components/schemas/CollectDataField' description: >- Deprecated: Use `schema` and `url` fields instead for webview-based data collection deprecated: true schema: description: JSON Schema for validating IC form data (for webview mode) url: type: string description: URL for webview-based data collection example: fields: - id: fullName name: Full name required: true type: text - id: dob name: Date of birth required: true type: date schema: $schema: https://json-schema.org/draft/2020-12/schema additionalProperties: false anyOf: - required: - pobCountry - pobAddress - required: - porCountry - porAddress properties: dob: description: Date of birth in YYYY-MM-DD format format: date title: Date of Birth type: string fullName: description: User's full legal name minLength: 1 title: Full Name type: string pobAddress: description: Place of birth city and state (e.g., 'New York, NY') maxLength: 200 title: Place of Birth Address type: string pobCountry: description: Place of birth country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Birth Country type: string porAddress: description: Place of residence street address, city, and state maxLength: 200 title: Place of Residence Address type: string porCountry: description: Place of residence country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Residence Country type: string tosConfirmed: const: true description: Must be true to confirm Terms of Service acceptance title: Terms of Service Confirmation type: boolean required: - fullName - dob - tosConfirmed type: object url: >- https://data-collection.walletconnect.com/ic/pay_123?accounts=eip155:1:0x123 GetPaymentResponse: type: object required: - status - amount - expiresAt - merchant properties: amount: $ref: '#/components/schemas/Amount' buyer: oneOf: - type: 'null' - $ref: '#/components/schemas/BuyerInfo' expiresAt: type: integer format: int64 minimum: 0 merchant: $ref: '#/components/schemas/MerchantInfo' status: $ref: '#/components/schemas/PaymentStatus' example: amount: display: assetName: USD Coin assetSymbol: USDC decimals: 6 iconUrl: https://assets.walletconnect.com/usdc.png networkIconUrl: https://assets.walletconnect.com/base.png networkName: Base unit: caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000 value: '1000000' buyer: accountCaip10: eip155:1:0x0000000000000000000000000000000000000000 accountProviderIcon: https://example.com/icon.png accountProviderName: Wallet expiresAt: 1700000000 merchant: iconUrl: https://example.com/icon.png name: Merchant status: requires_action PaymentOption: type: object required: - id - account - amount - etaS - actions properties: account: type: string description: The account to use for the option actions: type: array items: $ref: '#/components/schemas/Action' description: Actions required to complete the option amount: $ref: '#/components/schemas/Amount' description: The option's token and amount collectData: oneOf: - type: 'null' - $ref: '#/components/schemas/CollectData' description: >- Per-option IC data collection info. Present when this option's account requires data collection, null otherwise. etaS: type: integer format: int64 description: Estimated time to complete the option, in seconds minimum: 0 expiresAt: type: - integer - 'null' format: int64 description: >- Unix timestamp (seconds) after which this quote is stale and confirm_payment will reject it with `quote_expired`. The wallet should re-fetch options before this deadline. `None` for direct-currency options that don't involve a rate. minimum: 0 id: type: string description: >- ID of the option to be used to refer to it in other requests. May be up to 2^16 characters. example: account: eip155:1:0x0000000000000000000000000000000000000000 actions: - data: chain_id: eip155:8453 method: eth_signTypedData_v4 params: - '0x0000000000000000000000000000000000000000' - >- {"domain":{"name":"USD Coin","version":"2","chainId":"0x2105","verifyingContract":"0x0000000000000000000000000000000000000000"},"types":{"EIP712Domain":[{"type":"string","name":"name"},{"type":"string","name":"version"},{"type":"uint256","name":"chainId"},{"type":"address","name":"verifyingContract"}],"ReceiveWithAuthorization":[{"type":"address","name":"from"},{"type":"address","name":"to"},{"type":"uint256","name":"value"},{"type":"uint256","name":"validAfter"},{"type":"uint256","name":"validBefore"},{"type":"bytes32","name":"nonce"}]},"primaryType":"ReceiveWithAuthorization","message":{"from":"0x0000000000000000000000000000000000000000","nonce":"0x0000000000000000000000000000000000000000000000000000000000000000","to":"0x0000000000000000000000000000000000000000","validAfter":"0x0","validBefore":"0x0","value":"0x0"}} type: walletRpc amount: display: assetName: USD Coin assetSymbol: USDC decimals: 6 iconUrl: https://assets.walletconnect.com/usdc.png networkIconUrl: https://assets.walletconnect.com/base.png networkName: Base unit: caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000 value: '1000000' collectData: fields: - id: fullName name: Full name required: true type: text - id: dob name: Date of birth required: true type: date schema: $schema: https://json-schema.org/draft/2020-12/schema additionalProperties: false anyOf: - required: - pobCountry - pobAddress - required: - porCountry - porAddress properties: dob: description: Date of birth in YYYY-MM-DD format format: date title: Date of Birth type: string fullName: description: User's full legal name minLength: 1 title: Full Name type: string pobAddress: description: Place of birth city and state (e.g., 'New York, NY') maxLength: 200 title: Place of Birth Address type: string pobCountry: description: Place of birth country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Birth Country type: string porAddress: description: Place of residence street address, city, and state maxLength: 200 title: Place of Residence Address type: string porCountry: description: Place of residence country code (ISO 3166-1 alpha-2) pattern: ^[A-Z]{2}$ title: Place of Residence Country type: string tosConfirmed: const: true description: Must be true to confirm Terms of Service acceptance title: Terms of Service Confirmation type: boolean required: - fullName - dob - tosConfirmed type: object url: >- https://data-collection.walletconnect.com/ic/pay_123?accounts=eip155:1:0x123 etaS: 5 expiresAt: 1700000300 id: opt_123 ErrorCode: type: string description: |- Standard error codes for API responses. This prevents typos like "invlaid_params" from reaching production. enum: - rate_limited - invalid_params - params_validation - payment_not_found - idempotency_conflict - internal_error - invalid_api_key - unauthorized - forbidden - invalid_state - payment_expired - quote_expired - missing_api_key - missing_merchant_api_key - missing_merchant_id - header_not_ascii - not_sandbox_api_key - merchant_not_found - merchant_exists - api_key_not_found - partner_not_found - customer_not_found - wallet_not_found - executor_not_found - missing_app_id - missing_client_id - invalid_app_id - conflicting_auth_headers - missing_auth_headers - invalid_api_version - unknown_api_version - api_version_downgrade - sanctioned_user - payment_not_succeeded - already_refunded CollectDataField: type: object required: - type - id - name - required properties: id: type: string description: ID of the field for submission name: type: string description: Human readable name of the field required: type: boolean description: Requiredness of the field type: $ref: '#/components/schemas/CollectDataFieldType' description: Type of the field example: id: fullName name: Full name required: true type: text Amount: type: object required: - unit - value - display properties: display: $ref: '#/components/schemas/AmountDisplay' description: Display information for the amount unit: type: string description: Currency unit, prefixed with either "iso4217/" or "caip19/" example: iso4217/USD value: type: string description: Amount value, in the currency unit's minor units example: display: assetName: USD Coin assetSymbol: USDC decimals: 6 iconUrl: https://assets.walletconnect.com/usdc.png networkIconUrl: https://assets.walletconnect.com/base.png networkName: Base unit: caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000 value: '1000000' BuyerInfo: type: object required: - accountCaip10 - accountProviderName properties: accountCaip10: type: string description: Account CAIP-10 accountProviderIcon: type: - string - 'null' description: Account provider icon URL accountProviderName: type: string description: Account provider name example: accountCaip10: eip155:1:0x0000000000000000000000000000000000000000 accountProviderIcon: https://example.com/icon.png accountProviderName: Wallet MerchantInfo: type: object required: - name properties: iconUrl: type: - string - 'null' description: Merchant icon URL name: type: string description: Merchant name example: iconUrl: https://example.com/icon.png name: Merchant PaymentStatus: type: string description: |- Payment status representing the lifecycle of a payment. Payments progress through these states from creation to terminal status. Some states are specific to the payment source (pull vs push). enum: - requires_action - processing - succeeded - failed - expired - cancelled Action: oneOf: - type: object description: An action that requires a wallet RPC call to complete required: - data - type properties: data: $ref: '#/components/schemas/WalletRpcAction' description: An action that requires a wallet RPC call to complete type: type: string enum: - walletRpc - type: object description: An action that requires building to complete required: - data - type properties: data: $ref: '#/components/schemas/Build' description: An action that requires building to complete type: type: string enum: - build example: data: chain_id: eip155:8453 method: eth_signTypedData_v4 params: - '0x0000000000000000000000000000000000000000' - >- {"domain":{"name":"USD Coin","version":"2","chainId":"0x2105","verifyingContract":"0x0000000000000000000000000000000000000000"},"types":{"EIP712Domain":[{"type":"string","name":"name"},{"type":"string","name":"version"},{"type":"uint256","name":"chainId"},{"type":"address","name":"verifyingContract"}],"ReceiveWithAuthorization":[{"type":"address","name":"from"},{"type":"address","name":"to"},{"type":"uint256","name":"value"},{"type":"uint256","name":"validAfter"},{"type":"uint256","name":"validBefore"},{"type":"bytes32","name":"nonce"}]},"primaryType":"ReceiveWithAuthorization","message":{"from":"0x0000000000000000000000000000000000000000","nonce":"0x0000000000000000000000000000000000000000000000000000000000000000","to":"0x0000000000000000000000000000000000000000","validAfter":"0x0","validBefore":"0x0","value":"0x0"}} type: walletRpc CollectDataFieldType: type: string enum: - text - date - checkbox AmountDisplay: type: object required: - assetSymbol - assetName - decimals properties: assetName: type: string description: Full name of the asset assetSymbol: type: string description: Ticker/symbol of the asset decimals: type: integer format: int32 description: Number of minor decimals of the asset minimum: 0 iconUrl: type: - string - 'null' description: URL of the icon of the asset (if token) networkIconUrl: type: - string - 'null' description: URL of the icon of the network (if token) networkName: type: - string - 'null' description: Name of the network of the asset (if token) example: assetName: USD Coin assetSymbol: USDC decimals: 6 iconUrl: https://assets.walletconnect.com/usdc.png networkIconUrl: https://assets.walletconnect.com/base.png networkName: Base WalletRpcAction: type: object required: - chain_id - method - params properties: chain_id: type: string method: type: string params: type: array items: {} example: chain_id: eip155:8453 method: eth_signTypedData_v4 params: - '0x0000000000000000000000000000000000000000' - >- {"domain":{"name":"USD Coin","version":"2","chainId":"0x2105","verifyingContract":"0x0000000000000000000000000000000000000000"},"types":{"EIP712Domain":[{"type":"string","name":"name"},{"type":"string","name":"version"},{"type":"uint256","name":"chainId"},{"type":"address","name":"verifyingContract"}],"ReceiveWithAuthorization":[{"type":"address","name":"from"},{"type":"address","name":"to"},{"type":"uint256","name":"value"},{"type":"uint256","name":"validAfter"},{"type":"uint256","name":"validBefore"},{"type":"bytes32","name":"nonce"}]},"primaryType":"ReceiveWithAuthorization","message":{"from":"0x0000000000000000000000000000000000000000","nonce":"0x0000000000000000000000000000000000000000000000000000000000000000","to":"0x0000000000000000000000000000000000000000","validAfter":"0x0","validBefore":"0x0","value":"0x0"}} Build: type: object required: - data properties: data: type: string example: data: ... securitySchemes: API Key: type: apiKey in: header name: Api-Key ApiKey: type: apiKey in: header name: Api-Key description: Private API key for wallet authentication AppId: type: apiKey in: header name: App-Id description: >- Public App ID for wallet authentication. When using this auth mode, the Client-Id header is also required. ````