diff --git a/api/asset-transfers/index.html b/api/asset-transfers/index.html index d0cd861ca..1bfda962e 100644 --- a/api/asset-transfers/index.html +++ b/api/asset-transfers/index.html @@ -18,7 +18,7 @@
Go to home page
Docs

Asset Transfers

An asset transfer is an asynchronous exchange of an asset or an amount to a recipient.

+
Go to home page
Docs

Asset Transfers

An asset transfer is an asynchronous exchange of an asset or an amount to a recipient.

A recipient is an existing Centrapay user or someone who can create an account to claim the asset transfer by verifying their phone number.

After an asset transfer is completed the recipientAlias, lastSentTo and @@ -67,7 +67,7 @@

POST/api/asset-transfers

Create an Asset Transfer

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.

Attributes

  • assetId

    stringrequired

    Id of a discrete asset to transfer or wallet to draw from.

  • recipientAlias

    string

    Phone number, email or handle of receiver.

  • description

    string

    Shows up in transaction history against the transfer. 200 character limit.

  • message

    string

    Shows up in transaction history against the transfer. 100 character limit.

  • value

    bignumber

    Amount to send. Required for money transfers. Units depend on the asset type.

  • senderName

    string

    Human readable name for the sender. 30 character limit.

  • suppressNotification

    boolean

    Suppress notifications from Centrapay (SMS/Email).

Errors

  • INSUFFICIENT_WALLET_BALANCE

    403

    The value of the asset-transfer exceeds the balance on the wallet.

  • QUOTA_EXCEEDED

    403

    The transfer exceeds one or more spend quota limits. See Quota Error Response  API .

  • ASSET_NOT_ACTIVE

    403

    The asset is not active and cannot be transferred.

  • RECIPIENT_MISSING

    403

    The asset must be transferred with a recipient supplied.

Request
POST/api/assets/asset-transfers
    curl -X POST https://service.centrapay.com/api/asset-transfers \
+returned in these cases. The url will link to a page to claim the asset.
Attributes
  • assetId
    stringrequired
    Id of a discrete asset to transfer or wallet to draw from.
  • recipientAlias
    string
    Phone number, email or handle of receiver.
  • description
    string
    Shows up in transaction history against the transfer. 200 character limit.
  • message
    string
    Shows up in transaction history against the transfer. 100 character limit.
  • value
    bignumber
    Amount to send. Required for money transfers. Units depend on the asset type.
  • senderName
    string
    Human readable name for the sender. 30 character limit.
  • suppressNotification
    boolean
    Suppress notifications from Centrapay (SMS/Email).
Errors
  • INSUFFICIENT_WALLET_BALANCE
    403
    The value of the asset-transfer exceeds the balance on the wallet.
  • QUOTA_EXCEEDED
    403
    The transfer exceeds one or more spend quota limits. See Quota Error Response  API .
  • ASSET_NOT_ACTIVE
    403
    The asset is not active and cannot be transferred.
  • RECIPIENT_MISSING
    403
    The asset must be transferred with a recipient supplied.
  • INVALID_ASSET_TYPE
    403
    The asset’s type  API  does not support transfers.
Request
POST/api/assets/asset-transfers
    curl -X POST https://service.centrapay.com/api/asset-transfers \
   -H "X-Api-Key: $api_key" \
   -H "Content-Type: application/json" \
   -d '{