You can use this API to perform an update action on a specific payment.
The actions that you can perform are:
ACCEPT
ACCEPT
You can use this action to accept payments sent via check-in in PENDING
status.
Or you can use this action to accept payments with the flow FUND_LOCK
and PRE_AUTHORIZED_FUND_LOCK
in AUTHORIZED
status.
If you're accepting a fund lock, you must also send the amount_unit
parameter. This parameter must be equal to or less than the one used during payment creation.
CANCEL
CANCEL
You can use this action to cancel payments sent via check-in in PENDING
status.
Or you can use this action to cancel payments with the flow FUND_LOCK
and PRE_AUTHORIZED_FUND_LOCK
in AUTHORIZED
status.
In this case, the funds will be immediately be unlocked and returned back to the consumer's wallet.
CANCEL_OR_REFUND
⚠️
CANCEL_OR_REFUND
⚠️We strongly suggest you to use this action only if you are not able to retrieve the actual payment status.
This could be due to either temporary unavailability of Satispay or network issues.
By executing the CANCEL_OR_REFUND
action, we prevent situations where a user confirms a payment, the payment is accepted, but the product is not issued to the user.
What this action will do is:
- refund the payment if it is in an
ACCEPTED
status. - cancel the payment if it is in a
PENDING
orAUTHORIZED
status.
The response will also change accordingly, please check our response examples.
RETRY
If the API returns an error, such as a
500
, it does not necessarily mean that the payment has not already been accepted.If you encounter this error, we suggest retrying the request within a few seconds.
If you still do not receive a response, execute an Update Payment using theCANCEL_OR_REFUND
action.
CANCEL vs REFUND payments
A payment can only transition to
CANCELED
status if it has not yet reached theACCEPTED
status.
Once a payment reachesACCEPTED
, it can no longer be canceled.If an
ACCEPTED
payment needs to be refunded you need to create a payment with aREFUND
flow.