PayBright has been acquired by Affirm. Adyen will not accept new PayBright integrations.
This page explains how to add PayBright to your existing iOS Drop-in integration.
Requirements
Select which endpoint you are using:
API reference
Select which endpoint you are using:
Drop-in configuration
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
Partial captures are not available if you enabled automatic capture in your Customer Area.
To partially capture a PayBright payment, specify in your /capture request:
modificationAmount: The amount that the shopper should pay.additionalData.openinvoicedata:Price and product information for the items that the shopper should pay for.Optional
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:
| openinvoicedata | lineItems | Description |
|---|---|---|
itemAmount |
amountExcludingTax |
The price for one item, without the tax, in minor units. |
itemVatAmount |
taxAmount |
The tax amount for one item, in minor units. |
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.
To set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture.
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:Price and product information about the returned items.Optional
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:
| openinvoicedata | lineItems | Description |
|---|---|---|
itemAmount |
amountExcludingTax |
The price for one item, without the tax, in minor units. |
itemVatAmount |
taxAmount |
The tax amount for one item, in minor units. |
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.