Forwarding Wallet

V 2.0

Bitcoin QR code icon

Contents

Forwarding wallet accept and immediately forward payment to your wallet. Also, it has the ability to split forwarding payment.

Les paiements entrants peuvent être divisés en 255 adresses. Les destinataires recevront le montant exact spécifié ou un pourcentage (quota) de cette somme. C'est un moyen très pratique pour payer en une seule fois des livraisons, des intermédiaires en cas de marketing à plusieurs niveaux, recevoir des commissions ou simplement envoyer une somme d'argent en cold storage. Dans le cas d'un paiement fractionné avec montant spécifié, la somme restante sera automatiquement envoyée à la dernière adresse. You can create a lot of wallets for your project.

Chaque paiement est divisé selon l'ordre des destinataires indiqué sur la liste, et cela jusqu'au dernier Satoshi. Les paiements sont en effet réalisés selon un ordre précis, de la première adresse de destination indiquée jusqu'à la dernière, qui reçoit le montant restant une fois toutes les transactions réalisées. L'ordre des adresses doit donc être parfaitement hiérarchisé. Et votre adresse doit toujours se trouver en dernière position pour que la somme restante vous soit retournée.

Request:

JSON Schema parameters

Utiliser une requête POST contenant un objet au format JSON.

{type} Wallet type: "saving" or "forwarding" Obligatoire
Callback URL

Le callback est un tableau d'URL de rappel et de paramètres de données d'utilisateurs.

{callback:url}
string,
=< 1024 chars

Callback URL
L'adresse URL de votre serveur reçoit les données relatives au paiement. L'adresse URL indiquée doit obligatoirement être valide.

Obligatoire
{callback:data}
tableau

Données
Le tableau associatif est basé sur des paires de valeur-clé. Vous pouvez l'utiliser comme un identificateur supplémentaire ou dans le but de sécuriser une adresse bitcoin générée.

Par exemple 'secret' = '7j0ap91o99cxj8k9' or 'invoice_id'='1234'

Facultatif

Adresse de destination et montant

Vos adresses bitcoin de destination où les paiements confirmés seront transférées. Minimum 1, maximum 100 adresses de destination.

Paramètres Description Obligatoire Exemples
{destinations}
string,
32 - 42 chars
Adresse de destination

Votre adresse de destination vers laquelle les paiements confirmés seront transférés.

Obligatoire

1apiKcJM95jENZeom2dQo8ShK7dUQkRaS

bc1qggg2ys8duv4qvnfgzng2p75m6ehklcmfygr9m4

{amount}
(integer | "percent in string")

Montant

Un montant en Satoshi ou un pourcentage. Ces paramètres peuvent être manquants ou vides. Dans ce cas précis, le montant restant sur cette transaction sera transféré à cet endroit.

Facultatif

253999

"20%"

"31.55%"

Request example:
{
"type": "forwarding",
"callback":{                       #optional
      "url": "your_callback_URL",  #optional
      "data":{                     #optional
         "optional_key": "value"
      }
   },
	"destinations":[           #Adresses de destination pour les portefeuilles de transfert uniquement
      {"amount": <amount|"percents">, "address": "<bitcoin_address>"},
		... #from 1 to 255 addresses
	]
}

Success Response Reference:

{wallet}
string
Wallet identificator. Wallet contain bitcoin addresses. Obligatoire
{transfer_key}
string
Key for payment transfer (withdrawal). Obligatoire
{type}
string
Wallet type: "saving" or "forwarding". Obligatoire
{currency}
string
Currency type: btc. Obligatoire
{callback}
array
Specified array of callback URL and user's Data parameters. Facultatif
{destinations} Votre adresse de destination vers laquelle les paiements confirmés seront transférés. Obligatoire
Response example:

{
  "wallet": "8e9c53a62755bcc66e4d2aaae3a2af6d",
  "type": "saving",
  "transfer_key": "7j0ap91o99cxj8k97j0ap91o99cxj8k9",
  "currency": "btc",
  "callback":
  {
     "url": "http://example.com/callback",
     "data":
     {
        "invoice_id": "1234",
        "secret": "7j0ap91o99cxj8k9",
     }
  },
  "destinations":[
	{"address": "1apiKcJM95jENZeom2dQo8ShK7dUQkRaS", "amount": 40330},
	{"address": "1ApiwpetcWnBbkpU7cb7biPfc6Tiucasf8", "amount": 40330}
  ]
}

Message d'erreur

Playground and Code examples:

Callback URL CléValeur

+

AdresseMontant

+


{
   "type": "forwarding",
   "callback":{
      "url" :  "http://example.com/callback"
   }
}
  
<?php
  $json_data = array (
    'type' => "forwarding",
    'callback' => array(
        'url'=> "http://example.com/callback"
    )
  );
  
  $api_endpoint = "https://apirone.com/api/v2/btc/wallet";
 
  $curl = curl_init($api_endpoint);
  curl_setopt($curl, CURLOPT_HTTPHEADER, array("Content-Type: application/json"));
  curl_setopt($curl, CURLOPT_POST, 1);
  curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($json_data));
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
  $response = curl_exec($curl);
  $http_status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
  curl_close($curl);
 
  if ($http_status_code==200){
	  $decoded = json_decode($response, true);
	  echo "Wallet: " . $decoded["wallet"] . "<BR>";
	  echo "Key: " . $decoded["transfer_key"];
  } else {
      var_dump($response);
  }
?>
Envoyer une requête
Réponse du serveur: