Sign in

v1

latestOpenAPI 3.0.12026-08-062379143.9 KB
Payments

Void transaction

Void a transaction. You can void payments, returns, and pre-auths completions. It will cancel that transaction.

post/payments/{transId}/void

Path parameters

transIdnumber required

The transaction id to void.

Request body

amountnumber double required

A decimal value in dollars. Must be equal to the original purchase amount. You can void purchases as well as pre-auths and returns.

order_numberstring

A unique order number.

Response

Payment response containing the payment details as well as if the transaction was approved or declined.

idstring

transaction Id

authorizing_merchant_idinteger

The id of the merchant that authorized the transaction.

approvedstring

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_idinteger

Payment response code

messagestring

Message containing information about the transactions status

auth_codestring

Auth Code

createdstring date-time

Time stamp of when the transaction occurred

order_numberstring

Order number

type'P' | 'R' | 'VP' | 'VR' | 'PA' | 'PAC'

Payment transaction type

risk_scorenumber double

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amountnumber double

A decimal value in dollars. Uses up to two decimal places.

payment_method'card' | 'token' | 'payment_profile' | 'cash' | 'cheque' | 'apple_pay' | 'google_pay'

Payment method

merchant_datastring

Returned only for 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contentsstring

Returned only for 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the 3D Secure processing page.