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.

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

Add UMAD-11 for request #29

Merged
merged 1 commit into from
Sep 10, 2024
Merged
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions umad-11-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# UMAD-11 Request

UMA requests are a way to deliver UMA invoices to sending wallets through methods like
deep/universal links on mobile, notifications, 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 an 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
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 user to confirm the
payment.
Loading