Void Transaction

Endpoint for initiating Void type of Transactions.

info

Please be aware that this endpoint requires a Manage Transactions API Key.

POST /api/v1/groups/{group_id}/transaction{transaction_id}/reversal

Request Parameters

Name	Description	Type	Required
type	void	string	Required

Response

Code	Description
200	Success
400	Bad Request / Validation error
500	Internal Error

Example Usage

JavaScript

transaction.js

var headers = new Headers();
headers.append('Authorization', 'API_KEY');

var requestOptions = {
	method: 'POST',
	headers: headers,
	redirect: 'follow',
	body: {
		// request body data
	}
};
const group_id = '';
fetch(`https://api.reverepayments.dev/api/v1/groups/${group_id}/transaction`, requestOptions)
	.then((response) => response.text())
	.then((result) => console.log(result))
	.catch((error) => console.log('error', error));

Python

transaction.py

import requests

url = "https://api.reverepayments.dev/api/v1/groups/{group_id}/transaction/{transaction_id}/reversal"

headers = {
  'Authorization': 'API_KEY'
}

response = requests.request("POST", url, headers=headers, json={
// request body data
})

print(response.text)

Go

transaction.go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {

	url := "https://api.reverepayments.dev/api/v1/groups/{group_id}/transaction/{transaction_id}/reversal"

	client := &http.Client{}
	body := bytes.NewBuffer(nil)
	_ = json.NewEncoder(body).Encode(map[string]any{
		// body data
	})
	req, _ := http.NewRequest("POST", url, body)
	req.Header.Add("Authorization", "API_KEY")
	res, _ := client.Do(req)
	defer res.Body.Close()
	bytes, err := io.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err.Error())
		return
	}
	fmt.Println(string(bytes))
}

Example Request

{
	"type": "void",
	"referenced_transaction_id": "b5cc858f-4639-4916-9d67-4209c2b6339c"
}

Example Success Response

{
	"id": "b5cc858f-4639-4916-9d67-4209c2b6339c",
	"group_id": "<group_id>",
	"gateway": "revere_pay",
	"processor_id": "<processor_id>",
	"processor_name": "NO AFFILIATE",
	"processor_type": "revere_pay",
	"transaction_type": "sale",
	"payment_method": "card",
	"payment_details": {
		"card": {
			"brand": "Mastercard",
			"first_six": "555555",
			"last_four": "4444",
			"customer_name": "Mike Jackson",
			"expiration_date": "26/11",
			"avs": "not available",
			"cvv": "no match",
			"issued_country": "US"
		}
	},
	"amounts": {
		"requested_amount": 10000,
		"authorized_amount": 10000,
		"captured_amount": 10000
	},
	"currency": "USD",
	"description": "Test Void",
	"source": "api",
	"order_id": "",
	"po_number": "",
	"email_receipt": false,
	"email_address": "mikejackson@example.com",
	"billing_address": {
		"first_name": "Mike",
		"last_name": "Jackson",
		"company": "Mike's",
		"city": "Pasadena",
		"line_1": "North Los Robles Avenue 2311",
		"line_2": "4A",
		"subdivision": "CA",
		"postal_code": "91104",
		"country": "US",
		"email": "mikejackson@example.com"
	},
	"shipping_address": {
		"first_name": "Mike",
		"last_name": "Jackson",
		"company": "Mike's",
		"city": "Pasadena",
		"line_1": "North Los Robles Avenue 2311",
		"line_2": "4A",
		"subdivision": "CA",
		"postal_code": "91104",
		"country": "US"
	},
	"form_external_id": "",
	"form_entry_id": "",
	"subscription_id": "",
	"plan_id": "",
	"custom_fields": null,
	"response_code": "SUCCESS",
	"response_text": "confirmed",
	"status": "voided",
	"created_at": "2024-04-11T14:39:28.455701Z"
}