Update Payment
To update a payment, make a PUT request to the following endpoint:
https://api.peach-in.com/v4/payment/{paymentId}Replace
{paymentId}with the unique identifier of the payment you want to update.
Request
Include your API key in the Authorization header of the request, as described in the Authorization section.
Response
A successful response to the updated payment endpoint will return a success message.
PUT https://api.peach-in.com/v4/payment/{paymentId}
Request Body
action*
string
available:
updatedSum
number
required if action updateHokAdditionalRecurringSum
updatedChargeDay
number
day of month (1-31), required if action changeChargeDay
freezeUntil
string
format - 'yyyy-mm', required if action freezeSubscription
updatedCycles
number
for unlimited use 999, required if action updateCycles
key
string
required if action is "updatePayment". This is the key you want to update (for example "donorFirstName")
value
string
required if action is "updatePayment". This is the value you want to update (for example "Dan")
{
"message":"success"
}Note:
The API response returns "message": "success" to indicate that the update request was received and processed successfully.
However, this does not necessarily mean that the payment was actually updated — only that the request itself was executed without errors.
Last updated