Skip to content

Commit

Permalink
Add UMAD-11 for request
Browse files Browse the repository at this point in the history
  • Loading branch information
zhenlu committed Sep 6, 2024
1 parent aec9a4f commit da340cc
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions umad-11-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# UMAD-11 Request

UMA request is a way to deliver UMA invoices to sending wallets. Such as deep/universal links on

Check failure on line 3 in umad-11-request.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces

umad-11-request.md:3:97 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md009.md
mobile, notification, etc.

## Request for non-specified sender

To deliver a UMA invoice to a sending wallet, the receiver can create a UMA invoice, and then
deliver the encoded UMA invoice string to the sending wallet.

The invoice string should be delivered using the following URL pattern:

```raw
uma://<invoice_string>
```

This can be displayed as a QR code, or a deep link on mobile. The sending wallet should register
the `uma` scheme to handle the UMA invoice string.

## Request for specified sender

To deliver a UMA invoice with a specified sender, the receiver can create a UMA invoice, and then
directly send the UMA invoice to the sending VASP.

The request URL should be defined in the uma-configuration scheme (See UMAD-10 for details) as:

```raw
"uma_request_endpoint": "https://vasp1.com/path/to/request/url"
```

The sending VASP should implement the request endpoint as a POST endpoint that accepts the UMA

Check failure on line 31 in umad-11-request.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Trailing spaces

umad-11-request.md:31:95 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md009.md
invoice. The payload should be a JSON object with the following fields:

```raw
{
"invoice": "<UMA invoice string>"
}
```

Once sending VASP receives the UMA invoice, it should notify the sending wallet to confirm the payment.

Check failure on line 40 in umad-11-request.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Files should end with a single newline character

umad-11-request.md:40:103 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md047.md

0 comments on commit da340cc

Please sign in to comment.