Provided the payment has not reached SETTLED
status, Primer will
send a “void” request to the payment processor, thereby cancelling the payment
and releasing the hold on customer funds. Upon success, the payment will transition
to CANCELLED
. The payload is optional.
Payments API
Cancel a payment
POST
This endpoint returns an object
The unique payment ID.
You can use this ID to retrieve the payment details, or perform downstream operations.
The type of card token used for the payment.
Only applies for card payments.
Allowed values: CARD_PANNETWORK_TOKENPROCESSOR_TOKEN
Check this field for more information regarding the payment’s status. This is especially useful when the status is DECLINED
or FAILED
.
A list summarizing the transactions that occurred while processing the payment.
Note: a refund is a separate transaction and so will appear in this transactions
list if a refund was performed.
POST
Response