Merge pull request #816 from centrapay/create-asset-transfer-link

Create asset transfer without recipientAlias
centrapay · Oct 18, 2023 · 92b408d · 92b408d
2 parents ed20d3d + 50802f9
commit 92b408d
Showing 1 changed file with 38 additions and 9 deletions.
diff --git a/legacy/src/api/assets/asset-transfers.md b/legacy/src/api/assets/asset-transfers.md
@@ -46,6 +46,9 @@ Asset Transfer goes through different lifecycle stages.
 Transfer an asset to a recipient. Some assets can be transfered only in whole
 (eg giftcards or tokens) while others can be transfered only in part (eg money).
 
+Some assets can be transferred without supplying a recipient. A `url` field will be
+returned in these cases. The `url` will link to a page to claim the asset.
+
 {% reqspec %}
   POST '/api/asset-transfers'
   auth 'api-key'
@@ -64,6 +67,12 @@ Transfer an asset to a recipient. Some assets can be transfered only in whole
       recipientAlias: '+642212312'
     })
   }
+  example {
+    title 'Without Recipient'
+    body ({
+      assetId: 'sai2Pai7ohgongo',
+    })
+  }
 {% endreqspec %}
 
 
@@ -72,20 +81,20 @@ Transfer an asset to a recipient. Some assets can be transfered only in whole
 | Parameter      | Type   | Description                                                |
 |:---------------|:-------|:-----------------------------------------------------------|
 | assetId        | String | Id of a discrete asset to transfer or wallet to draw from. |
-| recipientAlias | String | Phone number, email or handle of receiver.                 |
 
 
 {% h4 Optional Parameters %}
 
-| Parameter   | Type               | Description                                                                     |
-| :---------- | :-----             | :---------                                                                      |
-| description | String             | Shows up in transaction history against the transfer. {% maxlen 200 %}          |
-| message     | String             | A message which shows up in the SMS of the receiver. {% maxlen 100 %}           |
-| value       | {% dt BigNumber %} | Amount to send. Required for money transfers. Units depend on the asset type.   |
-| senderName  | String             | Human readable name for the sender. {% maxlen 30 %}                             |
-| suppressNotifications | Boolean  | Suppress notifications from Centrapay (SMS/Email).                              |
+|       Parameter       |        Type        |                                  Description                                  |
+| :-------------------- | :----------------- | :---------------------------------------------------------------------------- |
+| recipientAlias        | String             | Phone number, email or handle of receiver.                                    |
+| description           | String             | Shows up in transaction history against the transfer. {% maxlen 200 %}        |
+| message               | String             | A message which shows up in the SMS of the receiver. {% maxlen 100 %}         |
+| value                 | {% dt BigNumber %} | Amount to send. Required for money transfers. Units depend on the asset type. |
+| senderName            | String             | Human readable name for the sender. {% maxlen 30 %}                           |
+| suppressNotifications | Boolean            | Suppress notifications from Centrapay (SMS/Email).                            |
 
-{% h4 Example response payload %}
+{% h4 Example response payload (With Recipient) %}
 
 {% json %}
 {
@@ -108,13 +117,33 @@ Transfer an asset to a recipient. Some assets can be transfered only in whole
 
 The above example has $10 left on a $60 dollar giftcard at the time of transfer.
 
+{% h4 Example response payload (Without Recipient) %}
+
+{% json %}
+{
+  "id": "M7Kn2stAxNa6ri7h",
+  "status": "created",
+  "value": "1000",
+  "assetId": "YGRo6TYYSxH3js7",
+  "assetType": "centrapay.token.main",
+  "description": "Centrapay Token",
+  "message": "Happy birthday",
+  "senderName": "CentraCafe",
+  "createdAt": "2020-05-01T12:30:00.000Z",
+  "updatedAt": "2020-05-02T01:03:37.222Z",
+  "suppressNotifications": false,
+  "url": "https://app.centrapay.com/transfer/M7Kn2stAxNa6ri7h"
+}
+{% endjson %}
+
 {% h4 Error Responses %}
 
 | Status |                   Code                    |                                   Description                                    |
 | :----- | :---------------------------------------- | :------------------------------------------------------------------------------- |
 | 403    | {% break _ INSUFFICIENT_WALLET_BALANCE %} | The value of the asset-transfer exceeds the balance on the wallet                |
 | 403    | {% break _ QUOTA_EXCEEDED %}              | The transfer exceeds one or more spend quota limits. See [Quota Error Response]. |
 | 403    | {% break _ ASSET_NOT_ACTIVE %}            | The asset is not active and cannot be transferred.                               |
+| 403    | {% break _ RECIPIENT_MISSING %}           | The asset must be transferred with a recipient supplied.                         |
 
 
 ## Get an Asset Transfer