Refund Transaction

Endpoint for initiating Refund 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	refund	string	Required
amounts.requested_amount	The amount to be refunded.	uint64	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/{transaction_id}/reversal`,
	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": "refund",
	"referenced_transaction_id": "c05861f0-6384-414d-b837-0ed71cefbbe5",
	"amounts": {
		"requested_amount": 3000
	}
}

Example Success Response

{
	"id": "c05861f0-6384-414d-b837-0ed71cefbbe5",
	"group_id": "<group_id>",
	"gateway": "revere_pay",
	"processor_id": "<processor_id>",
	"processor_name": "NO AFFILIATE",
	"processor_type": "revere_pay",
	"transaction_type": "refund",
	"payment_method": "card",
	"payment_details": {
		"card": {
			"brand": "Visa",
			"first_six": "411111",
			"last_four": "1111",
			"customer_name": "James Testington",
			"expiration_date": "26/11",
			"avs": "not available",
			"cvv": "no match",
			"issued_country": "US"
		}
	},
	"amounts": {
		"requested_amount": 3000,
		"authorized_amount": 3000,
		"captured_amount": 3000,
		"settled_amount": 3000,
		"refunded_amount": 3000,
		"included_tax_amount": 300,
		"included_shipping_amount": 1000
	},
	"currency": "USD",
	"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed lacus ac mi gravida euismod. Curabitur augue sapien, aliquam eu varius eu, gravida ac nunc. Duis commodo imperdiet augue. Proin consequat odio et pretium molestie.",
	"source": "api",
	"order_id": "98765",
	"po_number": "12345",
	"email_receipt": false,
	"email_address": "test@example.com",
	"billing_address": {
		"first_name": "James",
		"last_name": "Testington",
		"company": "James' Company",
		"city": "Scranton",
		"line_1": "Slough Avenue",
		"line_2": "1725",
		"subdivision": "PA",
		"postal_code": "18505",
		"country": "US",
		"email": "test@example.com"
	},
	"shipping_address": {
		"first_name": "James",
		"last_name": "Testington",
		"company": "James' Company",
		"city": "Scranton",
		"line_1": "Slough Avenue",
		"line_2": "1725",
		"subdivision": "PA",
		"postal_code": "18505",
		"country": "US"
	},
	"form_external_id": "",
	"form_entry_id": "",
	"subscription_id": "",
	"plan_id": "",
	"custom_fields": null,
	"response_code": "SUCCESS",
	"response_text": "confirmed",
	"status": "pending",
	"created_at": "2024-04-11T14:27:17.952373Z"
}