Skip to content
Home » Octopush Gateway SMS API » API Sub-Accounts » Transfer credit

Transfer credit

POST
https://api.octopush.com/v1/public/subaccount/credit-transfer/transfer

Encoding : UTF-8

Authentication

Your “api-key” and “api-login” must be added in the headers.

Definition

This service allows you to transfer credit from your main account to a sub-account.

To do this, you need a transfer token. This is a token that authorises a transaction. There can be no more than one valid token.

Special parameters

NameTypeDescription
tokenstringTransfer token obtained in a previous step.
from_wallet_pack_idstringIdentifier of the wallet pack to be debited.
amountintegerTransfer amount in euros.

Curl Example

curl -X POST \ 
'https://api.octopush.com/v1/public/subaccount/credit-transfer/transfer' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "token": "******************************",
  "from_wallet_pack_id": "abc123abc456abc",
  "amount": 25
}'

JSON Server Response

Success : 200 OK

{
 "wallet_pack_from":{
    "id":"1232-323232-33223",
    "residual_credit":120.0
  },
  "wallet_pack_to":{
    "id":"9843-4343-89768",
    "residual_credit":800.0
  } 
}