Sign in
Credits

Transfer credits to another account

Before you can use the transfer credits endpoint, the credit-transfer facility must be activated for your account. You can request activation from support@bulksms.com.

The recipient must be an enabled account that uses the same currency as your account.

post/credit/transfer

Request body

toUsernamestring required

The username of the account that will receive the credits.

toUserIdnumber required

The numeric user ID of the account that will receive the credits. The ID must match the username.

creditsnumber required

The amount of credits to transfer.

commentOnFromstring

An optional note that will be shown on the credit history of your account. The maximum length of the comment is 100.

commentOnTostring

An optional note that will be shown on the credit history of the recipient's account. The maximum length of the comment is 100.

Example request

{
  "toUsername": "roboto",
  "toUserId": 2345,
  "credits": 2345,
  "commentOnFrom": "Tranfer to Bobby",
  "commentOnTo": "Tranfer from Danny"
}

Response

An empty body when the credits were transferred OK.

Changes

No recorded changes to this endpoint across all 1 revision of this API.