Payment-method icon

PayBright for API only

Add PayBright to an existing API-only integration.

PayBright has been acquired by Affirm. Adyen will not accept new PayBright integrations.

Accept PayBright payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

When making an PayBright payment, you also need to:

  1. Collect shopper details, and specify these in your payment request. PayBright uses these for risk checks.
  2. Provide information about the purchased items by specifying lineItems in your payment request.
  3. Handle the redirect result after the shopper returns to your website.

Requirements

Requirement Description
Integration type Make sure that you have built an API-only integration.
Setup steps Before you begin, add PayBright in your test Customer Area.

Build your payment form for PayBright

If you are using /paymentMethods to show which payment methods are available to the shopper,
specify the following combinations of countryCode and amount.currency in your request:

Country/region countryCode amount.currency
Canada CA CAD

We provide a PayBright logo which you can use on your payment form. For more information, refer to Downloading logos.

To perform risk checks, PayBright requires you to collect the following shopper details:

  • Full name
  • Date of birth
  • Email address
  • Phone number
  • Billing address and delivery address.

Make a payment

Make a /payments request from your server, specifying:

  • paymentMethod: paybright
  • shopperName: The shopper's full name.
  • dateOfBirth: The shopper's date of birth.
  • shopperEmail: The shopper's email address.
  • telephoneNumber: The shopper's phone number.
  • shopperLocale
    Optional
    : A combination of language code and country code to define which language should be used in the PayBright checkout page.
  • countryCode: The shopper's country. For example, CA.
  • billingAddress: The postal address to be included on the invoice.
  • deliveryAddress: The postal address where the purchased items will be shipped.
  • lineItems: Price and product information about the purchased items.
  • returnUrl: The URL where the shopper is redirected back to after completing the payment.