infoOverview
About this API
This API is used by the business to initiate a refund for an order.
keySecurity
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Locationheader
Field name
apikeyExample value
YOUR_WABA_API_KEYrouteParameters
Path Parameters
Substitute these placeholders in the endpoint URL before sending the request.
NameTypeRequirementDescription
phone_number_idstringRequiredResource identifier for phone number id.uploadInput
Request Body
Send a application/json payload. Replace placeholder values with data from your integration.
Top-Level Fields
NameTypeRequirementDescription
speedstringNot specifiedRequest value for speed.amountobjectNot specifiedRequest value for amount.reference_idstringNot specifiedRequest value for reference id.payment_config_idstringNot specifiedRequest value for payment config id.{
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
}{
"type": "object",
"properties": {
"speed": {
"type": "string"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"offset": {
"type": "string"
},
"currency": {
"type": "string"
}
}
},
"reference_id": {
"type": "string"
},
"payment_config_id": {
"type": "string"
}
}
}codeIntegration
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
shield_lockCredentials protectedAdd secrets only in your secure server environment.
curl --request POST 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages' \
--header 'apikey: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
}'const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages', {
method: 'POST',
headers: {
"apikey": "<API_KEY>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages', {
method: 'POST',
headers: {
"apikey": "<API_KEY>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);import json
import requests
url = 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages'
headers = {
"apikey": "<API_KEY>",
"Content-Type": "application/json"
}
payload = json.loads(r'''{
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
String body = """
{
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
}
""";
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages"))
.header("apikey", "<API_KEY>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());<?php
$curl = curl_init();
$payload = '{
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
}';
curl_setopt_array($curl, [
CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ["apikey: <API_KEY>","Content-Type: application/json"],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
var json = """
{
"speed": "normal",
"amount": {
"value": "100",
"offset": "100",
"currency": "INR"
},
"reference_id": "{{reference_id}}",
"payment_config_id": "{{payment_config_id}}"
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
"bytes"
)
func main() {
request, err := http.NewRequest("POST", "https://partnersv1.pinbot.ai/v3/{phone_number_id}/messages", bytes.NewBufferString("{\n \"speed\": \"normal\",\n \"amount\": {\n \"value\": \"100\",\n \"offset\": \"100\",\n \"currency\": \"INR\"\n },\n \"reference_id\": \"{{reference_id}}\",\n \"payment_config_id\": \"{{payment_config_id}}\"\n}"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
request.Header.Set("Accept", "application/json")
request.Header.Set("apikey", "<API_KEY>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}downloadOutput
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{
"200": {
"id": "refund-id",
"status": "pending",
"speed_processed": "normal"
}
}{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"speed_processed": {
"type": "string"
}
}
}ruleHTTP Responses
Status Codes
200The request was successful.400Bad request or invalid parameters.401API key is missing or invalid.403The request is not authorized for this resource.404The requested resource was not found.500The server encountered an error.