Skip to content
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

docs: mi/547/update-sender-recipient #576

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
+135 −134
Open

docs: mi/547/update-sender-recipient #576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3100e43
docs: mi/547/update-sender-recipient
hajjimo Mar 20, 2025
59618f9
docs: mi/547/update-sender-recipient
hajjimo Mar 21, 2025
d76d657
mi/547/update-sender-recipient
hajjimo Mar 21, 2025
e5bd50b
docs: mi/547/update-sender-recipient
hajjimo Mar 21, 2025
2001c9f
Merge branch 'main' into mi/547/update-sender-recipient
hajjimo Apr 1, 2025
efcadf7
docs: mi/547/update-sender-recipient
hajjimo Apr 2, 2025
8a793b8
docs: mi/547/update-sender-recipient
hajjimo Apr 2, 2025
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
28 changes: 14 additions & 14 deletions docs/src/content/docs/guides/make-onetime-payment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Import `createAuthenticatedClient` from the Open Payments SDK package.

Create an Open Payments-authenticated client by providing the following properties:

- `walletAddressURL` : your Open Payments-enabled wallet address that your client will use to authenticate itself to one or more Authorization Servers (AS).
- `walletAddressURL` : your Open Payments-enabled wallet address that your client will use to authenticate itself to one or more authorization servers.
- `privateKey` : the EdDSA-Ed25519 key or preferably the absolute or relative file path to the key that is bound to your wallet address. A public key signed with this private
key must be made available as a public JWK document at `{walletAddressUrl}/jwks.json` url.
- `keyId` : the identifier of the private key and the corresponding public key.
Expand All @@ -73,7 +73,7 @@ Create an Open Payments-authenticated client by providing the following properti

### 3. Request an Incoming Payment grant

Request an `incomingPayment` grant from the payee wallet's AS.
Request an `incomingPayment` grant from the recipient wallet's authorization server.

<ChunkedSnippet
source='https://raw.githubusercontent.com/interledger/open-payments-snippets/main/grant/grant-incoming-payment.ts'
Expand All @@ -82,11 +82,11 @@ Request an `incomingPayment` grant from the payee wallet's AS.

### 4. Create an Incoming Payment

Create an `incomingPayment` on the payee wallet's Resource Server (RS) using the access token returned by the AS in the grant request and specify the `walletAddress` with the URL of the payee's wallet.
Create an `incomingPayment` on the recipient wallet's resource server using the access token returned by the authorization server in the grant request and specify the `walletAddress` with the URL of the recipient's wallet.

Add the `incomingAmount` object and define the following properties:

- `value` : the maximum allowable amount that will be paid to the payee's wallet address.
- `value` : the maximum allowable amount that will be paid to the recipient's wallet address.
- `assetCode` : the ISO 4217 currency code representing the underlying asset used to make the payment.
- `assetScale` : the scale of amounts denoted in the corresponding asset code.

Expand All @@ -99,7 +99,7 @@ Optionally you may add the `expiresAt` property which is the date and time after

### 5. Request a Quote grant

Request a `quote` grant from the payer wallet's AS.
Request a `quote` grant from the sender wallet's authorization server.

<ChunkedSnippet
source='https://raw.githubusercontent.com/interledger/open-payments-snippets/main/grant/grant-quote.ts'
Expand All @@ -108,12 +108,12 @@ Request a `quote` grant from the payer wallet's AS.

### 6. Create a Quote

Create a `quote` on the payer wallet's RS using the access token returned by the AS in the grant request.
Create a `quote` on the sender wallet's resource server using the access token returned by the authorization server in the grant request.

Add the following properties:

- `method` : the payment method used to facilitate the payment. Set this property to `ilp` as Open Payments only supports <LinkOut href='https://interledger.org'>Interledger</LinkOut> payments at this time.
- `walletAddress` : the URL of the payer's wallet address.
- `walletAddress` : the URL of the sender's wallet address.
- `receiver` : the URL of the incoming payment that will receive the payment.

<ChunkedSnippet
Expand All @@ -123,17 +123,17 @@ Add the following properties:

### 7. Request an Outgoing Payment grant

Request an `outgoingPayment` grant from the payer wallet's AS.
Request an `outgoingPayment` grant from the sender wallet's authorization server.

Add the `limits` object with the following properties:

- `debitAmount` : the maximum amount to be deducted from the payer's wallet.
- `receiveAmount` : the maximum amount to be received in the payee's wallet.
- `debitAmount` : the maximum amount to be deducted from the sender's wallet.
- `receiveAmount` : the maximum amount to be received in the recipient's wallet.

:::note
This request requires an interactive grant as the payer will need to consent before an `outgoingPayment` is made against their wallet.
This request requires an interactive grant as the sender will need to consent before an `outgoingPayment` is made against their wallet.

For details on how to facilitate an interactive grant please see the <LinkOut href='https://openpayments.dev/guides/create-interactive-grant/'>
For details on how to facilitate an interactive grant refer to the <LinkOut href='https://openpayments.dev/guides/create-interactive-grant/'>
Create an Interactive Grant guide. </LinkOut>
:::

Expand All @@ -144,11 +144,11 @@ Create an Interactive Grant guide. </LinkOut>

### 8. Create an Outgoing Payment

Create an `outgoingPayment` on the payer wallet's RS using the access token returned by the AS in the grant request.
Create an `outgoingPayment` on the sender wallet's resource server using the access token returned by the authorization server in the grant request.

Add the following properties:

- `walletAddress` : the URL of the payer's wallet address.
- `walletAddress` : the URL of the sender's wallet address.
- `quoteId` : the URL of the quote specifying the payment amount.

<ChunkedSnippet
Expand Down
32 changes: 16 additions & 16 deletions docs/src/content/docs/guides/make-recurring-payments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Import `createAuthenticatedClient` from the Open Payments SDK package.

Create an Open Payments-authenticated client by providing the following properties:

- `walletAddressURL` : your Open Payments-enabled wallet address that your client will use to authenticate itself to one or more Authorization Servers (AS).
- `walletAddressURL` : your Open Payments-enabled wallet address that your client will use to authenticate itself to one or more authorization servers.
- `privateKey` : the EdDSA-Ed25519 key or preferably the absolute or relative file path to the key that is bound to your wallet address. A public key signed with this private
key must be made available as a public JWK document at `{walletAddressUrl}/jwks.json` url.
- `keyId` : the identifier of the private key and the corresponding public key.
Expand All @@ -76,7 +76,7 @@ Create an Open Payments-authenticated client by providing the following properti

### 3. Request an Incoming Payment grant

Request an `incomingPayment` grant from the payee wallet's AS.
Request an `incomingPayment` grant from the recipient wallet's authorization server.

<ChunkedSnippet
source='https://raw.githubusercontent.com/interledger/open-payments-snippets/main/grant/grant-incoming-payment.ts'
Expand All @@ -85,11 +85,11 @@ Request an `incomingPayment` grant from the payee wallet's AS.

### 4. Create an Incoming Payment

Create an `incomingPayment` on the payee wallet's Resource Server (RS) using the access token returned by the AS in the grant request and specify the `walletAddress` with the URL of the payee's wallet.
Create an `incomingPayment` on the recipient wallet's resource server using the access token returned by the authorization server in the grant request and specify the `walletAddress` with the URL of the recipient's wallet.

Add the `incomingAmount` object and define the following properties:

- `value` : the maximum allowable amount that will be paid to the payee's wallet address.
- `value` : the maximum allowable amount that will be paid to the recipient's wallet address.
- `assetCode` : the ISO 4217 currency code representing the underlying asset used to make the payment.
- `assetScale` : the scale of amounts denoted in the corresponding asset code.

Expand All @@ -102,7 +102,7 @@ Optionally you may add the `expiresAt` property which is the date and time after

### 5. Request a Quote grant

Request a `quote` grant from the payer wallet's AS.
Request a `quote` grant from the sender wallet's authorization server.

<ChunkedSnippet
source='https://raw.githubusercontent.com/interledger/open-payments-snippets/main/grant/grant-quote.ts'
Expand All @@ -111,12 +111,12 @@ Request a `quote` grant from the payer wallet's AS.

### 6. Create a Quote

Create a `quote` on the payer wallet's RS using the access token returned by the AS in the grant request.
Create a `quote` on the sender wallet's resource server using the access token returned by the authorization server in the grant request.

Add the following properties:

- `method` : the payment method used to facilitate the payment. Set this property to `ilp` as Open Payments only supports <LinkOut href='https://interledger.org'>Interledger</LinkOut> payments at this time.
- `walletAddress` : the URL of the payer's wallet address.
- `walletAddress` : the URL of the sender's wallet address.
- `receiver` : the URL of the incoming payment that will receive the payment.

<ChunkedSnippet
Expand All @@ -126,18 +126,18 @@ Add the following properties:

### 7. Request an Outgoing Payment grant

Request an `outgoingPayment` grant from the payer wallet's AS.
Request an `outgoingPayment` grant from the sender wallet's authorization server.

Add the `limits` object with the following properties:

- `debitAmount` : the maximum amount to be deducted from the payer's wallet.
- `receiveAmount` : the maximum amount to be received in the payee's wallet.
- `debitAmount` : the maximum amount to be deducted from the sender's wallet.
- `receiveAmount` : the maximum amount to be received in the recipient's wallet.
- `interval` : the interval period conforming to the <LinkOut href="https://en.wikipedia.org/wiki/ISO_8601#Repeating_intervals">ISO8601 repeating interval string format.</LinkOut>

:::note
This request requires an interactive grant as the payer will need to consent before an `outgoingPayment` is made against their wallet.
This request requires an interactive grant as the sender will need to consent before an `outgoingPayment` is made against their wallet.

For details on how to facilitate an interactive grant please see the <LinkOut href='https://openpayments.dev/guides/create-interactive-grant/'>
For details on how to facilitate an interactive grant refer to the <LinkOut href='https://openpayments.dev/guides/create-interactive-grant/'>
Create an Interactive Grant guide. </LinkOut>
:::

Expand All @@ -148,11 +148,11 @@ Create an Interactive Grant guide. </LinkOut>

### 8. Create an initial Outgoing Payment

Create an `outgoingPayment` on the payer wallet's RS using the access token returned by the AS in the grant request.
Create an `outgoingPayment` on the sender wallet's resource server using the access token returned by the authorization server in the grant request.

Add the following properties:

- `walletAddress` : the URL of the payer's wallet address.
- `walletAddress` : the URL of the sender's wallet address.
- `quoteId` : the URL of the quote specifying the payment amount.

<ChunkedSnippet
Expand All @@ -175,11 +175,11 @@ Rotate the access token obtained from the previous `outgoingPayment` grant reque

### 10. Create another Outgoing Payment

Create another `outgoingPayment` on the payer wallet's RS using the new access token returned by the AS in the previous step.
Create another `outgoingPayment` on the sender wallet's resource server using the new access token returned by the authorization server in the previous step.

Add the following properties:

- `walletAddress` : the URL of the payer's wallet address.
- `walletAddress` : the URL of the sender's wallet address.
- `quoteId` : the URL of the quote specifying the payment amount.

<ChunkedSnippet
Expand Down
Loading