API - Planyo Web Services - modify_reservation_payment

You are here: Planyo » Help » API » modify_reservation_payment

modify_reservation_payment

Description:

Changes the status of a reservation payment.

Input:

payment_id int required

ID of the payment to be removed.

reservation_id int required

Reservation ID the payment belongs to.

payment_status int required

One of the values representing the status of the payment: 1 - payment successful, 2 - payment is pending, 3 - error, 4 - this is a refund

extra_info string optional

You can optionally assign a custom info text to the payment.

method string required

must be set to modify_reservation_payment

language string optional

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key string required

your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

status int

Status of the reservation after the payment

payment_id int

ID of the modified payment.

API playground:

Click here to test this function in the API playground.