PayBright Drop-in integration

Our Android Drop-in renders PayBright in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to check the payment result after the shopper returns to your app.

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

Show PayBright in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

To show PayBright in your payment form, specify in your /paymentMethods request:

• countryCode: CA
• amount.currency: CAD
• amount.value: The value of the payment, in minor units.

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod. Pass the paymentComponentData.paymentMethod to your server — these are the shopper details that you need to make the payment.

Make a payment

1. From your server, make a POST /payments request, specifying:

   • paymentMethod: The paymentComponentData.paymentMethod from your client app.
   • 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: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

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

If your integration is set up correctly, the action object is passed from your server to the client.

Handle the redirect

Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.

From your server, make a POST /payments/details request providing:

• details: The actionComponentData.details object from Drop-in.

You receive a response containing:

• resultCode: Use this to present the payment 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