Void

post

https://pg-sandbox.paymaya.com/p3/void

Void a previous successful transaction. A void can be performed on the following transactions:

Purchase / Sale
Authorization
Capture
Refund

Body Params

transactionReferenceNo

string

required

Unique reference number generated by P3 from a previous original transaction.

paymentTransactionReferenceNo

string

deprecated

Deprecated. Unique reference number generated by P3 from a previous successful Authorization/Purchase request. Use transactionReferenceNo instead.

merchant

object

Information about the merchant performing the request for the cardholder.

reason

string

required

length ≤ 512

Short description of the reason why the purchase transaction is being voided.

reasonCode

string

enum

required

Indicates the general category why the void / reversal operation is being performed. The following reason codes are supported.

Code	Description
`00`	Transaction voided upon request from the cardholder / customer
`01`	Transaction cannot be completed by the merchant (e.g., goods and services are no longer available after the purchase request has been approved)
`02`	Transaction voided due to an error encountered by the terminal and/or merchant application/system (e.g., in case of chip card processing, Issuer Authentication Data was rejected by the card)
`03`	Transaction voided due to communication failure or system timeout
`04`	Transaction voided due to card being pulled out from terminal before transaction completion

Allowed:

trace

object

Values supplied by the transaction originator / terminal that can be used for reconciliation of transactions

Headers

Request-Reference-No

string

required

length between 12 and 36

A reference number sent by the API caller to tag the transaction in P3.

X-Idempotency-Key

string

An id that marks the transmission/re-transmission for idempotency checks and identifies this transmission separately from other reference numbers

Longitude

number

A geographic coordinate that specifies the east–west position of a point on the Earth's surface

Latitude

number

A geographic coordinate that specifies the north-south position of a point on the Earth's surface

Responses

`202`

`message` and `code` in response body for more information

200Success

202In the case that a retransmission is sent while a first transmission is still ongoing, a pending response is returned with the HTTP status 202

defaultError encountered while processing. Please refer to HTTP status code, message and code in response body for more information

`202`

`message` and `code` in response body for more information