Reverse a payment
curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse"
payload = "https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode('https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse"
payload := strings.NewReader("\"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse\""
response = http.request(request)
puts response.read_body"{ \"object\": \"Payment\", \"id\": \"pay_1542t\", \"vid\": \"321337b1cab8a772226361775067d2f0edc6da4c\", \"created\": \"2021-09-21T15:53:50-07:00\", \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\" }, \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" }, \"invoice\": { \"object\": \"Invoice\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000\", \"vid\": \"9ffb84181078c521763e034bc59fda5ff4d5922a\", \"billing_service_period_start\": \"2021-09-21T00:00:00-07:00\", \"billing_service_period_end\": \"2021-10-20T00:00:00-07:00\", \"due_date\": \"2021-11-20T00:00:00-08:00\", \"invoice_date\": \"2021-09-21T00:00:00-07:00\", \"status\": \"Due\", \"invoice_currency\": \"USD\", \"invoice_balance\": 5, \"gross_charges_total\": 5, \"tax_charges_total\": 0, \"sales_tax_address\": { \"object\": \"Address\", \"vid\": \"a55528d1dfc10ba2aee1182984cc7c1494081d38\", \"name\": \"Home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"SAN MATEO\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\" }, \"credit_total\": 0, \"payments_received_total\": 1.99, \"invoice_line_items\": { \"object\": \"List\", \"data\": [ { \"object\": \"InvoiceItem\", \"index_number\": 0, \"type\": \"RecurringCharge\", \"sku\": \"bp_ailkyMoVZg5PrMtnTAN5fZaaUdA\", \"description\": \"product default plan ailkyMoVZg5PrMtnTAN\", \"quantity\": 1, \"unit_amount\": 0, \"tax_classification\": \"TaxExempt\", \"item_added\": \"2021-09-21T00:00:00-07:00\", \"item_removed\": null, \"item_serviceperiod_start\": \"2021-09-21T00:00:00-07:00\", \"item_serviceperiod_end\": \"2021-10-20T00:00:00-07:00\", \"billing_plan\": { \"object\": \"BillingPlan\", \"id\": \"bp_ailkyMoVZg5PrMtnTAN5fZaaUdA\", \"vid\": \"c4f0757bb3539eac1db58f4b306d6f7f711ebeec\" } }, { \"object\": \"InvoiceItem\", \"index_number\": 1, \"type\": \"RecurringCharge\", \"sku\": \"1hxIz8-_Iv9eNrdQhNnt43n0NWc\", \"description\": \"Test Product Description\", \"quantity\": 1, \"unit_amount\": 5, \"tax_classification\": \"TaxExempt\", \"item_added\": \"2021-09-21T00:00:00-07:00\", \"item_removed\": null, \"item_serviceperiod_start\": \"2021-09-21T00:00:00-07:00\", \"item_serviceperiod_end\": \"2021-10-20T00:00:00-07:00\", \"subscription_item\": { \"object\": \"SubscriptionItem\", \"id\": \"sub_item_VS88Yr_81gY01PZ01pNoAx9GgIk\", \"vid\": \"706de2f391644a3ad50ae0d33063d678563315e2\" } } ], \"total_count\": 2 }, \"invoice_tax_items\": { \"object\": \"List\", \"data\": [ { \"object\": \"InvoiceItem\", \"index_number\": 2, \"type\": \"Tax\", \"sku\": \"VIN_SALES_TAX\", \"description\": \"Sales Tax Total\", \"quantity\": 1, \"unit_amount\": 0, \"tax_classification\": \"TaxExempt\", \"item_added\": \"2021-09-21T00:00:00-07:00\", \"item_removed\": null, \"item_serviceperiod_start\": \"2021-09-21T00:00:00-07:00\", \"item_serviceperiod_end\": \"2021-10-20T00:00:00-07:00\" } ], \"total_count\": 1 }, \"invoice_payments\": { \"object\": \"List\", \"data\": [ { \"object\": \"Transaction\", \"id\": \"IWC00066765\", \"vid\": \"ea07d80c40f3458ebf03fed9579e0a72f3e853bc\", \"created\": \"2021-09-21T15:53:51-07:00\", \"amount\": 1.99, \"currency\": \"USD\", \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\", \"created\": \"2021-09-21T15:52:50-07:00\", \"email\": \"devnull@example.com\", \"email_type\": \"html\", \"company\": \"Lorem Ipsum Inc\", \"name\": \"Forest Chump\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"payment_methods\": { \"object\": \"List\", \"data\": [ { \"object\": \"PaymentMethod\", \"id\": \"pm1_map_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"vid\": \"76b70fae5c796d1327fb3a6db756f75a8600b991\", \"created\": \"2021-09-21T15:52:50-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 0, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:51-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXX4OrM\", \"last_digits\": \"4OrM\" }, \"account_holder\": \"pm1_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"636d13150ea64f071abfb60e578f47f1c097a0de\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm1_MACC\", \"primary\": true, \"active\": true } ], \"total_count\": 1 } }, \"source_payment_method\": { \"object\": \"PaymentMethod\", \"id\": \"pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"vid\": \"825e2a81c10ba3d52e83ad50cc4aa669d098391a\", \"created\": \"2021-09-21T15:52:51-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 1.99, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:52-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXXIThs\", \"last_digits\": \"IThs\" }, \"account_holder\": \"pm2_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"127a80b50f8517ba7e7d046a2e087fce4b5a7e0f\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm2_MACC\", \"primary\": false, \"active\": false }, \"status_log\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionStatus\", \"status\": \"Cancelled\", \"created\": \"2021-09-21T15:55:42-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Captured\", \"created\": \"2021-09-21T15:55:23-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Authorized\", \"created\": \"2021-09-21T15:54:13-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\", \"note\": \"VIN_900 - N/A\" }, { \"object\": \"TransactionStatus\", \"status\": \"New\", \"created\": \"2021-09-21T15:54:00-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" } ], \"total_count\": 4 }, \"payment_processor\": \"Vindicia\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"metadata\": { \"vin:BillingPlanUnit\": \"month\", \"VIN_PartialPaymentTxBId\": \"1144973\", \"vin:BillingPlanLength\": \"1\", \"vin:BillingPlanDurationInSeconds\": \"0\", \"vin:FutureAmount\": \"5.00\" }, \"items\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionItem\", \"sku\": \"VIN_PartialTxBPayment\", \"index_number\": 1, \"item_type\": \"Purchase\", \"name\": \"Partial Payment for Invoice sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000\", \"price\": 1.99, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"subtotal\": 1.99, \"total\": 1.99 }, { \"object\": \"TransactionItem\", \"sku\": \"Total Tax\", \"index_number\": 2, \"item_type\": \"Purchase\", \"name\": \"Total Tax\", \"price\": 0, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"discount\": 0, \"subtotal\": 0, \"total\": 0 } ], \"total_count\": 2 }, \"sales_tax_address\": { \"object\": \"Address\", \"vid\": \"a55528d1dfc10ba2aee1182984cc7c1494081d38\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"SAN MATEO\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\" }, \"subscription_sequence\": 1, \"billing_plan_sequence\": 1, \"original_billing_date\": \"2021-09-21T00:00:00-07:00\", \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" } } ], \"total_count\": 1 }, \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\" }, \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" }, \"billing_sequence\": 0 }, \"payment_method\": { \"object\": \"PaymentMethod\", \"id\": \"pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"vid\": \"825e2a81c10ba3d52e83ad50cc4aa669d098391a\" }, \"amount\": 1.99, \"currency\": \"USD\", \"overage_disposition\": \"applyToThisAutoBill\", \"transaction\": { \"object\": \"Transaction\", \"id\": \"IWC00066765\", \"vid\": \"ea07d80c40f3458ebf03fed9579e0a72f3e853bc\", \"created\": \"2021-09-21T15:53:51-07:00\", \"amount\": 1.99, \"currency\": \"USD\", \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\", \"created\": \"2021-09-21T15:52:50-07:00\", \"email\": \"devnull@example.com\", \"email_type\": \"html\", \"company\": \"Lorem Ipsum Inc\", \"name\": \"Forest Chump /home/kpeters/repos/cashbox/qa/client/rest/perl/rest_payments.t\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"payment_methods\": { \"object\": \"List\", \"data\": [ { \"object\": \"PaymentMethod\", \"id\": \"pm1_map_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"vid\": \"76b70fae5c796d1327fb3a6db756f75a8600b991\", \"created\": \"2021-09-21T15:52:50-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 0, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:51-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXX4OrM\", \"last_digits\": \"4OrM\" }, \"account_holder\": \"pm1_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"636d13150ea64f071abfb60e578f47f1c097a0de\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm1_MACC\", \"primary\": true, \"active\": true } ], \"total_count\": 1 } }, \"source_payment_method\": { \"object\": \"PaymentMethod\", \"id\": \"pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"vid\": \"825e2a81c10ba3d52e83ad50cc4aa669d098391a\", \"created\": \"2021-09-21T15:52:51-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 1.99, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:52-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXXIThs\", \"last_digits\": \"IThs\" }, \"account_holder\": \"pm2_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"127a80b50f8517ba7e7d046a2e087fce4b5a7e0f\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm2_MACC\", \"primary\": false, \"active\": false }, \"status_log\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionStatus\", \"status\": \"Cancelled\", \"created\": \"2021-09-21T15:55:42-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Captured\", \"created\": \"2021-09-21T15:55:23-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Authorized\", \"created\": \"2021-09-21T15:54:13-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\", \"note\": \"VIN_900 - N/A\" }, { \"object\": \"TransactionStatus\", \"status\": \"New\", \"created\": \"2021-09-21T15:54:00-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" } ], \"total_count\": 4 }, \"payment_processor\": \"Vindicia\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"metadata\": { \"vin:BillingPlanUnit\": \"month\", \"VIN_PartialPaymentTxBId\": \"1144973\", \"vin:BillingPlanLength\": \"1\", \"vin:BillingPlanDurationInSeconds\": \"0\", \"vin:FutureAmount\": \"5.00\" }, \"items\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionItem\", \"sku\": \"VIN_PartialTxBPayment\", \"index_number\": 1, \"item_type\": \"Purchase\", \"name\": \"Partial Payment for Invoice sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000\", \"price\": 1.99, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"subtotal\": 1.99, \"total\": 1.99 }, { \"object\": \"TransactionItem\", \"sku\": \"Total Tax\", \"index_number\": 2, \"item_type\": \"Purchase\", \"name\": \"Total Tax\", \"price\": 0, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"discount\": 0, \"subtotal\": 0, \"total\": 0 } ], \"total_count\": 2 }, \"sales_tax_address\": { \"object\": \"Address\", \"vid\": \"a55528d1dfc10ba2aee1182984cc7c1494081d38\", \"name\": \"Test Script: /home/kpeters/repos/cashbox/qa/client/rest/perl/rest_payments.t\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"SAN MATEO\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\" }, \"subscription_sequence\": 1, \"billing_plan_sequence\": 1, \"original_billing_date\": \"2021-09-21T00:00:00-07:00\", \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" } }, \"status\": \"Failure\" }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Reverse a payment
Reverse a payment action can be used to reverse payments made using the create a payment call and is only applicable for payments made using the Merchant Accepted Payment payment method. When the payment is reversed, status appears as Failure. The associated Transaction will be in TransactionStatus Cancelled.
Note:- For all other payment methods, use a Refund call instead.
POST
/
payments
/
{payment}
/
actions
/
reverse
Reverse a payment
curl --request POST \
--url https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse"
'import requests
url = "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse"
payload = "https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse"
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify('https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse')
};
fetch('https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode('https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse'),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse"
payload := strings.NewReader("\"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse\"")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("\"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse\"")
.asString();require 'uri'
require 'net/http'
url = URI("https://virtserver.swaggerhub.com/Amdocs_Media/Subscribe_API_WIP/2024.09/payments/{payment}/actions/reverse")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "\"https://api.staging.us-west.vindicia.com/payments/pay_1542t/actions/reverse\""
response = http.request(request)
puts response.read_body"{ \"object\": \"Payment\", \"id\": \"pay_1542t\", \"vid\": \"321337b1cab8a772226361775067d2f0edc6da4c\", \"created\": \"2021-09-21T15:53:50-07:00\", \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\" }, \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" }, \"invoice\": { \"object\": \"Invoice\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000\", \"vid\": \"9ffb84181078c521763e034bc59fda5ff4d5922a\", \"billing_service_period_start\": \"2021-09-21T00:00:00-07:00\", \"billing_service_period_end\": \"2021-10-20T00:00:00-07:00\", \"due_date\": \"2021-11-20T00:00:00-08:00\", \"invoice_date\": \"2021-09-21T00:00:00-07:00\", \"status\": \"Due\", \"invoice_currency\": \"USD\", \"invoice_balance\": 5, \"gross_charges_total\": 5, \"tax_charges_total\": 0, \"sales_tax_address\": { \"object\": \"Address\", \"vid\": \"a55528d1dfc10ba2aee1182984cc7c1494081d38\", \"name\": \"Home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"SAN MATEO\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\" }, \"credit_total\": 0, \"payments_received_total\": 1.99, \"invoice_line_items\": { \"object\": \"List\", \"data\": [ { \"object\": \"InvoiceItem\", \"index_number\": 0, \"type\": \"RecurringCharge\", \"sku\": \"bp_ailkyMoVZg5PrMtnTAN5fZaaUdA\", \"description\": \"product default plan ailkyMoVZg5PrMtnTAN\", \"quantity\": 1, \"unit_amount\": 0, \"tax_classification\": \"TaxExempt\", \"item_added\": \"2021-09-21T00:00:00-07:00\", \"item_removed\": null, \"item_serviceperiod_start\": \"2021-09-21T00:00:00-07:00\", \"item_serviceperiod_end\": \"2021-10-20T00:00:00-07:00\", \"billing_plan\": { \"object\": \"BillingPlan\", \"id\": \"bp_ailkyMoVZg5PrMtnTAN5fZaaUdA\", \"vid\": \"c4f0757bb3539eac1db58f4b306d6f7f711ebeec\" } }, { \"object\": \"InvoiceItem\", \"index_number\": 1, \"type\": \"RecurringCharge\", \"sku\": \"1hxIz8-_Iv9eNrdQhNnt43n0NWc\", \"description\": \"Test Product Description\", \"quantity\": 1, \"unit_amount\": 5, \"tax_classification\": \"TaxExempt\", \"item_added\": \"2021-09-21T00:00:00-07:00\", \"item_removed\": null, \"item_serviceperiod_start\": \"2021-09-21T00:00:00-07:00\", \"item_serviceperiod_end\": \"2021-10-20T00:00:00-07:00\", \"subscription_item\": { \"object\": \"SubscriptionItem\", \"id\": \"sub_item_VS88Yr_81gY01PZ01pNoAx9GgIk\", \"vid\": \"706de2f391644a3ad50ae0d33063d678563315e2\" } } ], \"total_count\": 2 }, \"invoice_tax_items\": { \"object\": \"List\", \"data\": [ { \"object\": \"InvoiceItem\", \"index_number\": 2, \"type\": \"Tax\", \"sku\": \"VIN_SALES_TAX\", \"description\": \"Sales Tax Total\", \"quantity\": 1, \"unit_amount\": 0, \"tax_classification\": \"TaxExempt\", \"item_added\": \"2021-09-21T00:00:00-07:00\", \"item_removed\": null, \"item_serviceperiod_start\": \"2021-09-21T00:00:00-07:00\", \"item_serviceperiod_end\": \"2021-10-20T00:00:00-07:00\" } ], \"total_count\": 1 }, \"invoice_payments\": { \"object\": \"List\", \"data\": [ { \"object\": \"Transaction\", \"id\": \"IWC00066765\", \"vid\": \"ea07d80c40f3458ebf03fed9579e0a72f3e853bc\", \"created\": \"2021-09-21T15:53:51-07:00\", \"amount\": 1.99, \"currency\": \"USD\", \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\", \"created\": \"2021-09-21T15:52:50-07:00\", \"email\": \"devnull@example.com\", \"email_type\": \"html\", \"company\": \"Lorem Ipsum Inc\", \"name\": \"Forest Chump\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"payment_methods\": { \"object\": \"List\", \"data\": [ { \"object\": \"PaymentMethod\", \"id\": \"pm1_map_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"vid\": \"76b70fae5c796d1327fb3a6db756f75a8600b991\", \"created\": \"2021-09-21T15:52:50-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 0, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:51-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXX4OrM\", \"last_digits\": \"4OrM\" }, \"account_holder\": \"pm1_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"636d13150ea64f071abfb60e578f47f1c097a0de\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm1_MACC\", \"primary\": true, \"active\": true } ], \"total_count\": 1 } }, \"source_payment_method\": { \"object\": \"PaymentMethod\", \"id\": \"pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"vid\": \"825e2a81c10ba3d52e83ad50cc4aa669d098391a\", \"created\": \"2021-09-21T15:52:51-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 1.99, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:52-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXXIThs\", \"last_digits\": \"IThs\" }, \"account_holder\": \"pm2_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"127a80b50f8517ba7e7d046a2e087fce4b5a7e0f\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm2_MACC\", \"primary\": false, \"active\": false }, \"status_log\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionStatus\", \"status\": \"Cancelled\", \"created\": \"2021-09-21T15:55:42-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Captured\", \"created\": \"2021-09-21T15:55:23-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Authorized\", \"created\": \"2021-09-21T15:54:13-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\", \"note\": \"VIN_900 - N/A\" }, { \"object\": \"TransactionStatus\", \"status\": \"New\", \"created\": \"2021-09-21T15:54:00-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" } ], \"total_count\": 4 }, \"payment_processor\": \"Vindicia\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"metadata\": { \"vin:BillingPlanUnit\": \"month\", \"VIN_PartialPaymentTxBId\": \"1144973\", \"vin:BillingPlanLength\": \"1\", \"vin:BillingPlanDurationInSeconds\": \"0\", \"vin:FutureAmount\": \"5.00\" }, \"items\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionItem\", \"sku\": \"VIN_PartialTxBPayment\", \"index_number\": 1, \"item_type\": \"Purchase\", \"name\": \"Partial Payment for Invoice sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000\", \"price\": 1.99, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"subtotal\": 1.99, \"total\": 1.99 }, { \"object\": \"TransactionItem\", \"sku\": \"Total Tax\", \"index_number\": 2, \"item_type\": \"Purchase\", \"name\": \"Total Tax\", \"price\": 0, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"discount\": 0, \"subtotal\": 0, \"total\": 0 } ], \"total_count\": 2 }, \"sales_tax_address\": { \"object\": \"Address\", \"vid\": \"a55528d1dfc10ba2aee1182984cc7c1494081d38\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"SAN MATEO\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\" }, \"subscription_sequence\": 1, \"billing_plan_sequence\": 1, \"original_billing_date\": \"2021-09-21T00:00:00-07:00\", \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" } } ], \"total_count\": 1 }, \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\" }, \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" }, \"billing_sequence\": 0 }, \"payment_method\": { \"object\": \"PaymentMethod\", \"id\": \"pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"vid\": \"825e2a81c10ba3d52e83ad50cc4aa669d098391a\" }, \"amount\": 1.99, \"currency\": \"USD\", \"overage_disposition\": \"applyToThisAutoBill\", \"transaction\": { \"object\": \"Transaction\", \"id\": \"IWC00066765\", \"vid\": \"ea07d80c40f3458ebf03fed9579e0a72f3e853bc\", \"created\": \"2021-09-21T15:53:51-07:00\", \"amount\": 1.99, \"currency\": \"USD\", \"account\": { \"object\": \"Account\", \"id\": \"nzCBtsC5-prtkjSNreuKfXAGoSs\", \"vid\": \"9ab512ff5f5122c38e136f505a63d39fd9d52261\", \"created\": \"2021-09-21T15:52:50-07:00\", \"email\": \"devnull@example.com\", \"email_type\": \"html\", \"company\": \"Lorem Ipsum Inc\", \"name\": \"Forest Chump /home/kpeters/repos/cashbox/qa/client/rest/perl/rest_payments.t\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"payment_methods\": { \"object\": \"List\", \"data\": [ { \"object\": \"PaymentMethod\", \"id\": \"pm1_map_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"vid\": \"76b70fae5c796d1327fb3a6db756f75a8600b991\", \"created\": \"2021-09-21T15:52:50-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 0, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:51-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_GqQ3IrVcaBdy9J7gPw71hA34OrM\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXX4OrM\", \"last_digits\": \"4OrM\" }, \"account_holder\": \"pm1_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"636d13150ea64f071abfb60e578f47f1c097a0de\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm1_MACC\", \"primary\": true, \"active\": true } ], \"total_count\": 1 } }, \"source_payment_method\": { \"object\": \"PaymentMethod\", \"id\": \"pm2_map_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"vid\": \"825e2a81c10ba3d52e83ad50cc4aa669d098391a\", \"created\": \"2021-09-21T15:52:51-07:00\", \"type\": \"MerchantAcceptedPayment\", \"merchant_accepted_payment\": { \"object\": \"MerchantAcceptedPayment\", \"amount\": 1.99, \"currency\": \"USD\", \"created\": \"2021-09-21T15:52:52-07:00\", \"payment_type\": \"WTF\", \"payment_id\": \"pId_tCLJ6gY5h_t5mZ5bjhdUyUdIThs\", \"account\": \"XXXXXXXXXXXXXXXXXXXXXXXIThs\", \"last_digits\": \"IThs\" }, \"account_holder\": \"pm2_Forest Chump\", \"billing_address\": { \"object\": \"Address\", \"vid\": \"127a80b50f8517ba7e7d046a2e087fce4b5a7e0f\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"customer_specified_type\": \"pm2_MACC\", \"primary\": false, \"active\": false }, \"status_log\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionStatus\", \"status\": \"Cancelled\", \"created\": \"2021-09-21T15:55:42-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Captured\", \"created\": \"2021-09-21T15:55:23-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" }, { \"object\": \"TransactionStatus\", \"status\": \"Authorized\", \"created\": \"2021-09-21T15:54:13-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\", \"note\": \"VIN_900 - N/A\" }, { \"object\": \"TransactionStatus\", \"status\": \"New\", \"created\": \"2021-09-21T15:54:00-07:00\", \"payment_method_type\": \"MerchantAcceptedPayment\" } ], \"total_count\": 4 }, \"payment_processor\": \"Vindicia\", \"shipping_address\": { \"object\": \"Address\", \"vid\": \"7bf5a88dcfaa0f17a22ce6aae671cc69a4d6c7f3\", \"name\": \"home\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"San Mateo\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\", \"phone\": \"(650) 555-1212x42\" }, \"metadata\": { \"vin:BillingPlanUnit\": \"month\", \"VIN_PartialPaymentTxBId\": \"1144973\", \"vin:BillingPlanLength\": \"1\", \"vin:BillingPlanDurationInSeconds\": \"0\", \"vin:FutureAmount\": \"5.00\" }, \"items\": { \"object\": \"List\", \"data\": [ { \"object\": \"TransactionItem\", \"sku\": \"VIN_PartialTxBPayment\", \"index_number\": 1, \"item_type\": \"Purchase\", \"name\": \"Partial Payment for Invoice sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0-00000000\", \"price\": 1.99, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"subtotal\": 1.99, \"total\": 1.99 }, { \"object\": \"TransactionItem\", \"sku\": \"Total Tax\", \"index_number\": 2, \"item_type\": \"Purchase\", \"name\": \"Total Tax\", \"price\": 0, \"quantity\": 1, \"tax_classification\": \"TaxExempt\", \"service_period_starts\": \"2021-09-21T00:00:00-07:00\", \"service_period_ends\": \"2021-10-20T00:00:00-07:00\", \"tax_type\": \"Exclusive Sales\", \"discount\": 0, \"subtotal\": 0, \"total\": 0 } ], \"total_count\": 2 }, \"sales_tax_address\": { \"object\": \"Address\", \"vid\": \"a55528d1dfc10ba2aee1182984cc7c1494081d38\", \"name\": \"Test Script: /home/kpeters/repos/cashbox/qa/client/rest/perl/rest_payments.t\", \"line1\": \"11235 Fibonacci St.\", \"city\": \"SAN MATEO\", \"district\": \"CA\", \"postal_code\": \"94403\", \"country\": \"US\" }, \"subscription_sequence\": 1, \"billing_plan_sequence\": 1, \"original_billing_date\": \"2021-09-21T00:00:00-07:00\", \"subscription\": { \"object\": \"Subscription\", \"id\": \"sub_Buoa4RPs8sxHZr4d6TC5qe_Wks0\", \"vid\": \"55ede4ee9230e90fa1887e5b28aaec61e16025d8\" } }, \"status\": \"Failure\" }""{ \"object\": \"Error\", \"message\": \"JSON is invalid\" }"{
"code": "<string>",
"message": "<string>"
}"{ \"object\": \"Error\", \"message\": \"This endpoint does not exist. Check our API docs.\" }"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The id or the vid of the payment to reverse. A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
Maximum string length:
128Body
application/json
JSON A full payment object.
Detail about the payment done
Value is "Payment"
Available options:
Payment The status of the Payment.
A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
Maximum string length:
128A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
Maximum string length:
128The time this payment was initiated
The Account represents a merchant’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in CashBox for billing. Read More in our User Guide
An Account can have any number of children accounts and may have up to one parent account. Read more in our User Guide.
An Account owns the “on file” payment methods to be used by it in billing.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Price
The Transaction object provides a way to charge a customer. You can create one-time transactions, retrieve individual transactions, fetch individual transactions, and list all Transactions for a given account or subscription. Posting with a new Transaction creates a new one-time Transaction object. If “to_be_captured” is false, the request will trigger an authorization attempt (based on the provided payment method’s authorization process). If successfully authorized, a subsequent post to the transaction’s actions/capture endpoint will capture the authorized transaction. If you post a new transaction with “to_be_captured” true, it will authorize and immediately capture the transaction if successful. To refund transactions, use the refunds endpoint.
Show child attributes
Show child attributes
ISO 4217 currency code to be used for this Payment Amount.
Response
JSON - A full Payment object.
Detail about the payment done
Value is "Payment"
Available options:
Payment The status of the Payment.
A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.
Maximum string length:
128A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.
Maximum string length:
128The time this payment was initiated
The Account represents a merchant’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in CashBox for billing. Read More in our User Guide
An Account can have any number of children accounts and may have up to one parent account. Read more in our User Guide.
An Account owns the “on file” payment methods to be used by it in billing.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Price
The Transaction object provides a way to charge a customer. You can create one-time transactions, retrieve individual transactions, fetch individual transactions, and list all Transactions for a given account or subscription. Posting with a new Transaction creates a new one-time Transaction object. If “to_be_captured” is false, the request will trigger an authorization attempt (based on the provided payment method’s authorization process). If successfully authorized, a subsequent post to the transaction’s actions/capture endpoint will capture the authorized transaction. If you post a new transaction with “to_be_captured” true, it will authorize and immediately capture the transaction if successful. To refund transactions, use the refunds endpoint.
Show child attributes
Show child attributes
ISO 4217 currency code to be used for this Payment Amount.