Skip to content

Update documentation based on source code changes #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation based on source code changes #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/base-account/reference/base-pay/pay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
```mdx
---
title: "pay"
description: "Send USDC payments on the Base network"
Expand Down Expand Up @@ -36,7 +37,7 @@ Array of information requests from the payer.
<ParamField body="type" type="string" required>
The type of information being requested.

**Possible values:** `'email' | 'physicalAddress' | 'phoneNumber' | 'name' | 'onchainAddress'`
**Possible values:** `'email' | 'physicalAddress' | 'phoneNumber' | 'name' | 'onchainAddress' | string`
</ParamField>

<ParamField body="optional" type="boolean">
Expand All @@ -51,9 +52,17 @@ Optional callback URL for server-side validation.
</Expandable>
</ParamField>

<ParamField body="walletUrl" type="string">
Optional wallet URL to use for the payment.
</ParamField>

<ParamField body="telemetry" type="boolean">
Whether to enable telemetry logging. Defaults to true.
</ParamField>

## Returns

<ResponseField name="result" type="PayResult">
<ResponseField name="result" type="PaymentResult">
Payment result indicating success or failure.

<Expandable title="Payment Success properties">
Expand Down Expand Up @@ -153,4 +162,5 @@ Always wrap calls to `pay` in a try-catch block to handle these errors gracefull

import PolicyBanner from "/snippets/PolicyBanner.mdx";

<PolicyBanner />
<PolicyBanner />
```