From c060294e957f7311806f8f50f7af3da25d553f06 Mon Sep 17 00:00:00 2001 From: Zhen Lu Date: Thu, 5 Sep 2024 18:10:01 -0700 Subject: [PATCH] Add UMAD-11 for request --- umad-11-request.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 umad-11-request.md diff --git a/umad-11-request.md b/umad-11-request.md new file mode 100644 index 0000000..25cefc3 --- /dev/null +++ b/umad-11-request.md @@ -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:// +``` + +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": "" +} +``` + +Once sending VASP receives the UMA invoice, it should notify the sending user to confirm the +payment.