Payment Links
#
Payment LinksPayment Links help you to receive payments from customers by sending them links via email, SMS, chat-bots and more. Payment Links can be created from the PortOne admin portal or API. The customer can select their desired payment method and complete the payment.
#
Generate Payment Link via APICreates a new payment link and return it along with it's unique id in response. Refer API docs for additional information.
#
Parameter listParameter | Datatype | Obligatory/Optional | Description |
---|---|---|---|
chaipay_key | Obligatory | Unique PortOne key for the merchant | |
merchant_order_id | Obligatory | Order reference generated by merchant | |
amount | Obligatory | Amount of transaction | |
currency | Obligatory | Currency of transaction | |
country_code | Obligatory | Country Code of transaction | |
billing_details | Optional | Details of billing | |
shipping_details | Optional | Details of shipping | |
merchant_details | Obligatory | Merchant details - name, promo_discount and shipping_charges are required field (promo_discount and shipping_charges must be set to 0 when not required) | |
order_details | Optional | Order Details like quantity, id, name, price are mandatory, while image is optional | |
success_url | Obligatory | Redirection url for success | |
failure_url | Obligatory | Redirection url for failure | |
pending_url | Obligatory | Redirection url for pending | |
signature_hash | Obligatory | Signature calculated using this link | |
expiry_date | Optional | Date and time to expire for the payment link in UTC format | |
source | Obligatory | From where payment link is created. Can be admin portal, checkout or api for which values are "default", "api", "checkout" respectively.Merchants should add "api" here | |
description | Optional | Description for payment link | |
environment | Obligatory | Environment of transaction either live OR sandbox | |
show_shipping_details | Optional | To Show/Hide the Shipping Details in Checkout UI | |
show_back_button | Optional | To Show/Hide the Back Button in Checkout UI | |
default_guest_checkout | Optional | To by default show the guest checkout in Checkout UI | |
is_checkout_embed | Optional | To load the checkout UI in Embedded way | |
notify_by_email | Optional | To notify customer by email | |
notify_by_phone | Optional | To notify customer by phone |
Curl Request:
Response: