API Documentation
1. Distributing payouts from your Dinar Box to other users' Dinar Boxes
Applications that have a money balance and need to process payouts to users that can be withdrawn immediately can use our API to achieve that. Here's how it works:
Endpoint: https://dinardragon.com/dinarbox-transfer
Method: POST
Body:
senderEmail: string;
(Payer's Dinar Box email address)
senderSecret: string;
(Payer's Dinar Box API Key)
recipientEmail: string;
(Recipient's Dinar Box email address)
amount: integer;
(Amount to send to recipient. We already know your currency, enter amount as an integer only)
triggerWebhook: true;
(Set to true to trigger a webhook event once the payment is complete)
webhookEndpoint: integer;
(URL to your webhook endpoint. We will send a POST request to this endpoint to confirm payment completion)
webhookSuccess: integer;
(https://dinardragon.com/linksuccess OR your own success URL)
Expected JSON Responses:
1. Payout Succeeded:
Response:
HTTP Status Code: 200;
success: true;
code: 3 (success);
response: responseMessage (string)
key: verificationKey (hashed string)
...additional properties with information about transaction
2. Payout Failed:
Response:
HTTP Status Code: 403;
code: 2 (missing data or incorrect body parameters) / 1 (insufficient funds);
success: false;
response: responseMessage (string)
key: verificationKey (hashed string)
...additional properties with information about transaction
2. Verifying Authenticity of Received Webhook Events When A Payment Is Made Via Your Payment Link
Anyone can send a webhook event to your server claiming to have made you a payment via your Dinar Dragon payment link.
To check if the received webhook event is legitimately from us or not, use the following API endpoint provided by Dinar Dragon:
Endpoint: https://dinardragon.com/verify-webhook-event
Method: POST
Body:
email: string;
(Your Dinar Box Email Address)
hashedKey: string;
(key property in received JSON response in webhook event)
Expected JSON Responses:
1. Webhook event actually is from us:
Response:
valid: true (boolean);
2. Webhook event is not from us:
Response:
valid: false (boolean);
3. POST request to /dinarbox-transfer endpoint, Code Examples
NOTE: For testing, run your localhost app through NGROK. We can only send webhook events to secure https addresses.
C++
#include <cpprest/http_client.h>
#include <iostream>
int main() {
web::http::client::http_client client(U("https://dinardragon.com/dinarbox-transfer"));
web::json::value postData;
postData[U("senderEmail")] = web::json::value::string("sender@example.com");
postData[U("senderSecret")] = web::json::value::string("apiKey");
postData[U("recipientEmail")] = web::json::value::string("recipient@example.com");
postData[U("amount")] = web::json::value::number(100);
postData[U("triggerWebhook")] = web::json::value::boolean(true);
postData[U("webhookEndpoint")] = web::json::value::string("https://your-webhook-endpoint.com");
client.request(web::http::methods::POST, U(""), postData)
.then([](web::http::http_response response) {
std::cout << "Response: " << response.status_code() << std::endl;
}).wait();
return 0;
}
C#
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
class Program {
static async Task Main() {
HttpClient client = new HttpClient();
var json = @"{
""senderEmail"": ""sender@example.com"",
""senderSecret"": ""apiKey"",
""recipientEmail"": ""recipient@example.com"",
""amount"": 100,
""triggerWebhook"": true,
""webhookEndpoint"": ""https://your-webhook-endpoint.com""
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
HttpResponseMessage response = await client.PostAsync("https://dinardragon.com/dinarbox-transfer", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
}
Java
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
public class Main {
public static void main(String[] args) throws Exception {
URL url = new URL("https://dinardragon.com/dinarbox-transfer");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Content-Type", "application/json");
conn.setDoOutput(true);
String jsonInputString = "{"
+ "\"senderEmail\": \"sender@example.com\","
+ "\"senderSecret\": \"apiKey\","
+ "\"recipientEmail\": \"recipient@example.com\","
+ "\"amount\": 100,"
+ "\"triggerWebhook\": true,"
+ "\"webhookEndpoint\": \"https://your-webhook-endpoint.com\""
+ "}";
try(OutputStream os = conn.getOutputStream()) {
byte[] input = jsonInputString.getBytes("utf-8");
os.write(input, 0, input.length);
}
System.out.println("Response Code: " + conn.getResponseCode());
}
}
JavaScript
fetch("https://dinardragon.com/dinarbox-transfer", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
senderEmail: "sender@example.com",
senderSecret: "apiKey",
recipientEmail: "recipient@example.com",
amount: 100,
triggerWebhook: true,
webhookEndpoint: "https://your-webhook-endpoint.com"
})
})
.then(response => response.json())
.then(data => console.log(data));
Go
package main
import (
"bytes"
"fmt"
"net/http"
)
func main() {
jsonData := []byte(`{
"senderEmail": "sender@example.com",
"senderSecret": "apiKey",
"recipientEmail": "recipient@example.com",
"amount": 100,
"triggerWebhook": true,
"webhookEndpoint": "https://your-webhook-endpoint.com"
}`)
resp, err := http.Post("https://dinardragon.com/dinarbox-transfer", "application/json", bytes.NewBuffer(jsonData))
if err != nil {
fmt.Println("Error:", err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
Python
import requests
url = "https://dinardragon.com/dinarbox-transfer"
payload = {
"senderEmail": "sender@example.com",
"senderSecret": "apiKey",
"recipientEmail": "recipient@example.com",
"amount": 100,
"triggerWebhook": True,
"webhookEndpoint": "https://your-webhook-endpoint.com"
}
response = requests.post(url, json=payload)
print(response.json())