Void a payment

POSThttps://api.dcdial.com/api/type=remove_payment

PaymentsToken

Voids a recorded payment, for example after a refund, NSF or chargeback, and reverses it on the account balance.

Parameters

Send as application/x-www-form-urlencoded.

typestringrequired
Selects the operation. Always remove_payment for this endpoint.
tokenstringrequired
Your API token from Log in. See Authentication.
account_idstringrequired
Your reference for the account (its accountid).
Example ACC-10045
reasonstringrequired
Why the payment is voided.
One ofrefundedNFScharged backother
payment_idstringrequired
ID of the payment to void.
Example 90311
company_idintegerrequired
Your DCDial company ID.
Example 101

curl https://api.dcdial.com/api/ \
  -d type=remove_payment \
  -d token="$DCDIAL_TOKEN" \
  -d account_id=ACC-10045 \
  -d reason=refunded \
  -d payment_id=90311 \
  -d company_id=101

<?php
$ch = curl_init('https://api.dcdial.com/api/');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => http_build_query([
        'type' => 'remove_payment',
        'token' => getenv('DCDIAL_TOKEN'),
        'account_id' => 'ACC-10045',
        'reason' => 'refunded',
        'payment_id' => '90311',
        'company_id' => 101,
    ]),
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

if (($result['response']['success'] ?? 0) != 1) {
    throw new RuntimeException($result['response']['error'] ?? 'Request failed');
}

const res = await fetch('https://api.dcdial.com/api/', {
  method: 'POST',
  body: new URLSearchParams({
    type: "remove_payment",
    token: process.env.DCDIAL_TOKEN,
    account_id: "ACC-10045",
    reason: "refunded",
    payment_id: "90311",
    company_id: "101",
  }),
});
const { response } = await res.json();
if (response.success != 1) throw new Error(response.error);

import os
import requests

r = requests.post(
    "https://api.dcdial.com/api/",
    data={
        "type": "remove_payment",
        "token": os.environ["DCDIAL_TOKEN"],
        "account_id": "ACC-10045",
        "reason": "refunded",
        "payment_id": "90311",
        "company_id": 101,
    },
    timeout=30,
)
response = r.json()["response"]
if str(response.get("success")) != "1":
    raise RuntimeError(response.get("error"))

{
  "response": {
    "success": 1,
    "error": ""
  }
}

Try it