Payment Link (User Guide)
Description
BridgerPay allows merchants to use the BP checkout solution as a payment link which can be sent via any communication channel (e.g., email, chat) to collect payments.
Prerequisites
A merchant should have an active checkout.
Minimum Requirements to Construct a Payment Link
cashierKey - Software-level credentials that identify a merchant;
orderId - Transaction ID within the merchant's system;
currency - Currency which a shopper's following payment transaction (deposit) will be originated in; designated according to ISO 4217 — Currency Codes (e.g. "USD", "CNY", or "EUR");
country- Country where the payment transaction will be made; designated according to ISO 3166-1 — Country Codes (e.g. "US", "CN", or "BE").
Amount is not considered a mandatory field. If not specified, the payment link will load with the default amount which was configured for the checkout.
Use cases
Payment Link (only mandatory fields)
Payment Link with Amount & Currency Specified and Locked (recommended)
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.23¤cyLock=true&amountLock=true
Payment Link with Amount Specified
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.23
Payment Link with Amount Specified & Locked
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.23&amountLock=true
Payment Link with Amount Specified & Currency Locked
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.23¤cyLock=true
SPECIAL Cases
Payment Link with Direct Payment Method Specified
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.
23¤cyLock=true&amountLock=true&directPaymentMethod=credit_card
If specified, the step during which the shopper could choose their preferred payment method is skipped, and the form of the "suggested" payment method is shown with an option to change it.
Payment Link with Single Payment Method Specified
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.
23¤cyLock=true&amountLock=true&singlePaymentMethod=credit_card
If specified, the step during which the shopper could choose a method is skipped, and the form of the "suggested" payment method is shown without an option to change it.
Payment Link with Single Payment Method & Single Payment Provider Specified
xxxxxxxxxxxx&orderId=i173aa01¤cy=EUR&country=BE&amount=15.
23¤cyLock=true&amountLock=true&singlePaymentMethod=apm&singlePaymentProvider=pay_pal
If specified, the shopper is allowed to pay through the specified PSP ONLY.