PayBright for API only

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

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:

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.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

   • When using the HTTP GET method:
     For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

   • Redirection for mobile integrations:
     For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

3. In the response note the following:

   • resultCode: use this to present the result to your shopper.
   • pspReference: our unique identifier for the transaction.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for PayBright are:

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

Capture the payment

By default, all PayBright payments are captured automatically after authorisation.

If you prefer to capture the payment after the goods have been sent, or when you want to partially capture payments, you need to set up a capture delay or use manual capture.

When you capture the payment, the shopper is charged for the first installment.

Partial captures

To partially capture a PayBright payment, specify in your /capture request:

• modificationAmount: The amount that the shopper should pay. 
• additionalData.openinvoicedata:
  Optional
  Price and product information for the items that the shopper should pay for.

Although the field names are different, the information in additionalData.openinvoicedata is the same as what you provided in lineItems when making a /payments request:

The following example shows how to make a partial capture request if the shopper only kept one pair of socks from the two included in the original payment request.

Any unclaimed amount that is left over after partially capturing a payment is automatically cancelled. When your account is enabled for multiple partial captures, the unclaimed amount after an initial capture is not automatically cancelled.

Refunds and cancellations

If a payment has not yet been captured, you can cancel it. If the PayBright payment has already been captured and you want to return the funds to the shopper, you need to refund it.

Partial refunds

To partially refund a payment, specify in your /payments/{paymentPspReference}/refunds request:

• modificationAmount: The amount to be refunded to the shopper.
• additionalData.openinvoicedata:
  Optional
  Price and product information about the returned items.

Providing additionalData.openinvoicedata is optional, and although the field names are different, the information is the same as what you provided in lineItems when making a /payments request:

The following example shows how to make a partial refund request if the shopper returned the shoes included in the original payment request.

Test and go live

To test PayBright payments, use the test details provided in the PayBright developer documentation.

You can check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live PayBright payments, you need to submit a request for PayBright in your live Customer Area.

See also