aljaz/fiatlink
1
0
Fork 0
mirror of https://github.com/aljazceru/fiatlink.git synced 2025-12-17 05:14:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into payment-info

Browse Source
This commit is contained in:
Aljaz Ceru
2023-11-02 17:01:34 +00:00
committed by GitHub
parent 8148eea696 82aa13943b
commit 97cf5e0ec1
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
FLS01/README.md
View File

@@ -11,8 +11,8 @@ The goal of this specification is to provide standardized API for applications t
## Fiat to Bitcoin ## Fiat to Bitcoin
### Wallet verification ### Wallet verification (optional)
To ensure user's ownership of the withdrawing wallet user must sign a message. Service provides the user with a message and user returns that message or part of the predefined message which the user then returns signed with his public key: Some jurisdictions require wallet verification by users so this spec supports it within the flow. To ensure user's ownership of the withdrawing wallet user can sign a message. Service provides the user with a message and user returns that message or part of the predefined message which the user then returns signed with his public key:
Example: Example:
``` ```
"node_pubkey": "02765a281bd188e80a89e6ea5092dcb8ebaaa5c5da341e64327e3fadbadcbc686c", "node_pubkey": "02765a281bd188e80a89e6ea5092dcb8ebaaa5c5da341e64327e3fadbadcbc686c",
@@ -58,8 +58,8 @@ Alternative options:
| Name | function | status | type | | Name | function | status | type |
|----------------|-------------------------------------------------|--------|--------| |----------------|-------------------------------------------------|--------|--------|
| /verify | get secret to verify wallet ownership | required | GET | | /verify | get secret to verify wallet ownership | required | GET |
| /auth | verify wallet ownership | required | POST | | /session | verify wallet ownership | required | POST |
| /quote | place order | required | POST | | /quote | place order | required | POST |
| /order | place order | required | POST | | /order | place order | required | POST |
| /order-status | get order status | required | GET | | /order-status | get order status | required | GET |
@@ -83,21 +83,21 @@ Response:
"expires_on": "2023-09-20T00:25:11.123Z" "expires_on": "2023-09-20T00:25:11.123Z"
} }
``` ```
- `token` random string from the provider that needs to be signed with the node pubkey - `token` (optional) random string from the provider that needs to be signed with the node pubkey in case wallet ownership proof is required. If token is not present then AOPP is not required.
- `session_id` uuid identifiying the client session - `session_id` uuid identifiying the client session
### auth ### session
Start a session with signed proof of ownership Start a session with optional signed proof of ownership. If Proof of Ownership is not required signature can be a random alphanumeric value.
Request: Request:
``` ```
POST /auth POST /session
{ {
"session_id": "d7ef9a88-1ca1-4ac8-bc9e-da3d9824cdc5", "session_id": "d7ef9a88-1ca1-4ac8-bc9e-da3d9824cdc5",
"id": "8ed13c2a-a8c6-4f0e-b43e-3fdbf1f094a6", "app_id": "8ed13c2a-a8c6-4f0e-b43e-3fdbf1f094a6",
"signature": "rdfe8mi98o7am51jpocda1zp5d8scdu7rg65nn73fs6mb69t4byer9xned1hntkeq1pqdct9z5owx6bg58w5fmny6p5q783dce8ittjh", "signature": "rdfe8mi98o7am51jpocda1zp5d8scdu7rg65nn73fs6mb69t4byer9xned1hntkeq1pqdct9z5owx6bg58w5fmny6p5q783dce8ittjh",
} }
``` ```
@@ -106,12 +106,12 @@ Response:
``` ```
{ {
"session_id": "d7ef9a88-1ca1-4ac8-bc9e-da3d9824cdc5", "session_id": "d7ef9a88-1ca1-4ac8-bc9e-da3d9824cdc5",
"id": "8ed13c2a-a8c6-4f0e-b43e-3fdbf1f094a6", "app_id": "8ed13c2a-a8c6-4f0e-b43e-3fdbf1f094a6",
"expires_on": "2023-09-20T00:25:11.123Z" "expires_on": "2023-09-20T00:25:11.123Z"
} }
``` ```
- `signature ` token from `/verify` signed by the node - `signature ` token from `/verify` signed by the node. In case `token` is not present in the `/verify` response signature is a random alphanumeric value.
- `id` client id (optional) - `app_id` app id (optional)
### quote ### quote