Skip to content

Commit

Permalink
Merge pull request #787 from centrapay/remove-sender-alias
Browse files Browse the repository at this point in the history
Remove senderAlias from asset transfers as it is unused
  • Loading branch information
Ray2126 authored Oct 4, 2023
2 parents 0f6e212 + 949ecf6 commit 3681922
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 9 deletions.
8 changes: 0 additions & 8 deletions legacy/src/api/assets/asset-transfers.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,8 @@ Transfer an asset to a recipient. Some assets can be transfered only in whole
| 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 %} |
| senderAlias | String | Phone number, email or handle of sender to return asset to. See (★) note below. |
| suppressNotifications | Boolean | Suppress notifications from Centrapay (SMS/Email). |

★ Only provide a senderAlias value if you are invoking asset transfer with api
key. In case that recipient doesn't claim asset in 2 weeks or asset was sent to
an invalid Alias (wrong phone number etc) we will use senderAlias to return the
asset. If asset cannot be returned to a sender it will be returned to asset
owner.


{% h4 Example response payload %}

{% json %}
Expand Down
2 changes: 1 addition & 1 deletion src/content/guides/loading-and-sending-assets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If your asset type is not included on the list, contact [email protected]

You can send Assets such as Tokens and Giftcards by calling our [Asset Transfers](https://docs.centrapay.com/api/asset-transfers#asset-transfer-create) endpoint. You will need to have the recipient’s phone number for `recipientAlias` to identify the reciever.

Optionally the `senderAlias` field can be used if you’re loading an asset on behalf of someone else. If the `recipientAlias` doesn’t end up creating a Centrapay account, then it will be sent to this number.
If the `recipientAlias` doesn’t end up creating a Centrapay account within 2 weeks, then it will be sent back to you.

## Example: Bulk distribution of Giftcards

Expand Down

0 comments on commit 3681922

Please sign in to comment.