Payment Page Details

This API allows partners to retrieve details of a payment page given its ID.

Retrieve details for a Payment Page given its ID

GET https://<PayEngine-host>/api/payment-page/:id

Path Parameters

Name	Type	Description
id*	string	Payment page ID

Response Body

Name	Type	Description	Required
payment_link_id	string	PayEngine system ID for the Payment page	Required
payment_link_status	string	ACTIVE, INACTIVE, COMPLETED, CANCELLED	Required
payment_link_url	string	Payment Link URL	Required
qr_code_url	string	Payment Link QR Code URL	Required
merchant_id	string	Merchant ID	Required
name	string	Name for the payment page	Required
organization_logo	file	OrganizationLogo provided in the request	Optional
payment_page_header	string	Title for the payment page	Optional
background_image	file	Background image provided in the request	Optional
description	string	Description of payment page	Optional
use_custom_field	string	True | False. True if the payment page will have the custom string field	Optional
custom_fields.custom_field_name	string	The name of the custom field. This is required if useCustomField is true	Optional
custom_fields.mandatory	boolean	True | False. If true, the custom field will be mandatory	Optional
completion_type	string	Values - message | redirect Message - means user will be displayed a message after successful transaction redirect - means the user will be redirected to the provided URL	Required
success_message	string	If completionType is message, then this is required and this is the success message that will be displayed after the successful transaction	Optional
redirect_url	string	If completionType is redirect, then this field is required. This is the URL where the user will be redirected to, after a successful transaction	Optional
start_date	string	Payment page will be active starting this date. If not provided the payment page will activate immediately.	Optional
end_date	string	Payment page will become INACTIVE after this date. If not provided the payment page will remain ACTIVE until cancelled.	Optional
payment_methods	array	Accepted values - CC_DC, ACH This field determine what payment methods option will be displayed to the user while paying. Default will be both values. CC_DC - stands for Credit Card and Debit Card ACH - Bank transfer	Optional
save_card_consent	boolean	True | False. True - Display the field to get user's consent to use the same payment details for future payments	Optional
metadata	object	Add any additional metadata by passing a json object	Optional
contact_info	boolean	True | False. True if the contact info section will be displayed in the payment page	Optional
contact_info_details.show_first_name	boolean	True | False. If true, display first name field in the contact Info	Optional
contact_info_details.mandatory_first_name	boolean	True | False. If true, the first name field will be mandatory in the payment page	Optional
contact_info_details.show_last_name	boolean	True | False. If true, display last name field in the contact Info	Optional
contact_info_details.mandatory_last_name	boolean	True | False. If true, the last name field will be mandatory in the payment page	Optional
contact_info_details.show_business_name	boolean	True | False. If true, display business name field in the contact Info	Optional
contact_info_details.mandatory_business_name	boolean	True | False. If true, the business name field will be mandatory in the payment page	Optional
contact_info_details.show_phone_number	boolean	True | False. If true, display phone number field in the contact Info	Optional
contact_info_details.mandatory_phone_number	boolean	True | False. If true, the phone number field will be mandatory in the payment page	Optional
contact_info_details.show_email_address	boolean	True | False. If true, display email address field in the contact Info	Optional
contact_info_details.mandatory_email_address	boolean	True | False. If true, the email address field will be mandatory in the payment page	Optional
contact_info_details.show_address	boolean	True | False. If true, display address field in the contact Info	Optional
contact_info_details.mandatory_address	boolean	True | False. If true, the address field will be mandatory in the payment page	Optional
button_text	string	Name of the button in the payment page. Default will be "Pay Now"	Optional
terms_and_conditions	string	Terms and Conditions string that will be displayed in the payment page	Optional
terms_and_conditions_text_color	string	HEX code for the text color for the terms and conditions string	Optional
internal_transaction_id	string	An internal ID from integrating system. Will be returned in the response. Note: This ID won't be displayed in the payment page	Optional
slug_id	string	Slug text for the generated payment page URL. By default, it is auto-generated. This slug text has to be unique in PayEngine environment	Optional

Sample Request

curl --location --request GET '<API_HOST>/api/payment-page/r1hzy' \
--header 'Authorization: Basic <API_KEY>'

Sample Response