VoidApi.md

CyberSource.VoidApi

All URIs are relative to https://apitest.cybersource.com

Method	HTTP request	Description
voidCapture	POST /pts/v2/captures/{id}/voids	Void a Capture
voidCredit	POST /pts/v2/credits/{id}/voids	Void a Credit
voidPayment	POST /pts/v2/payments/{id}/voids	Void a Payment
voidRefund	POST /pts/v2/refunds/{id}/voids	Void a Refund

voidCapture

PtsV2PaymentsVoidsPost201Response voidCapture(voidCaptureRequest, id)

Void a Capture

Include the capture ID in the POST request to cancel the capture.

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.VoidApi();

var voidCaptureRequest = new CyberSource.VoidCaptureRequest(); // VoidCaptureRequest | 

var id = "id_example"; // String | The capture ID returned from a previous capture request.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.voidCapture(voidCaptureRequest, id, callback);

Parameters

Name	Type	Description	Notes
voidCaptureRequest	VoidCaptureRequest
id	String	The capture ID returned from a previous capture request.

Return type

PtsV2PaymentsVoidsPost201Response

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/json;charset=utf-8

voidCredit

PtsV2PaymentsVoidsPost201Response voidCredit(voidCreditRequest, id)

Void a Credit

Include the credit ID in the POST request to cancel the credit.

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.VoidApi();

var voidCreditRequest = new CyberSource.VoidCreditRequest(); // VoidCreditRequest | 

var id = "id_example"; // String | The credit ID returned from a previous credit request.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.voidCredit(voidCreditRequest, id, callback);

Parameters

Name	Type	Description	Notes
voidCreditRequest	VoidCreditRequest
id	String	The credit ID returned from a previous credit request.

Return type

PtsV2PaymentsVoidsPost201Response

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/json;charset=utf-8

voidPayment

PtsV2PaymentsVoidsPost201Response voidPayment(voidPaymentRequest, id)

Void a Payment

Include the payment ID in the POST request to cancel the payment.

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.VoidApi();

var voidPaymentRequest = new CyberSource.VoidPaymentRequest(); // VoidPaymentRequest | 

var id = "id_example"; // String | The payment ID returned from a previous payment request.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.voidPayment(voidPaymentRequest, id, callback);

Parameters

Name	Type	Description	Notes
voidPaymentRequest	VoidPaymentRequest
id	String	The payment ID returned from a previous payment request.

Return type

PtsV2PaymentsVoidsPost201Response

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/json;charset=utf-8

voidRefund

PtsV2PaymentsVoidsPost201Response voidRefund(voidRefundRequest, id)

Void a Refund

Include the refund ID in the POST request to cancel the refund.

Example

var CyberSource = require('CyberSource');

var apiInstance = new CyberSource.VoidApi();

var voidRefundRequest = new CyberSource.VoidRefundRequest(); // VoidRefundRequest | 

var id = "id_example"; // String | The refund ID returned from a previous refund request.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.voidRefund(voidRefundRequest, id, callback);

Parameters

Name	Type	Description	Notes
voidRefundRequest	VoidRefundRequest
id	String	The refund ID returned from a previous refund request.

Return type

PtsV2PaymentsVoidsPost201Response

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json;charset=utf-8
• Accept: application/json;charset=utf-8