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

Name
Type
Description

action*

string

available:

cancelSubscription
updateHokAdditionalRecurringSum
changeChargeDay
freezeSubscription
updateCycles

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

{
    "message":"success"
}

Last updated