On This Page

Afterpay

Afterpay is a Buy Now, Pay Later service that allows customers to purchase items immediately and pay for them in four interest-free installments over a period of 6 weeks. Afterpay is also known as Clearpay in the UK, and Cash App Afterpay in the US.
For more information, see the
Afterpay and Clearpay Developer Guide
.

Opt in to Afterpay on
Unified Checkout

Follow these steps to opt in to the Afterpay/Clearpay payment method in
Unified Checkout
:
  1. Add Afterpay to your integration by adding
    AFTERPAY
     to the
    allowedPaymentTypes
     field within the capture context request. The default field value is
    AFTERPAY
     even if you want to support Cash App Afterpay in the US or Clear Pay in the UK.
  2. Set the
    completeMandate.type
     field value to
    AUTH
    ,
    CAPTURE
     or
    PREFER_AUTH
    .
    You can perform a sale and capture the funds immediately if you include the
    completeMandate.type
     field in the capture context request and set the value to
    CAPTURE
    .
    You can capture the funds later if you include the
    completeMandate.type
     field in the capture context request and set the value to
    AUTH
    . When you capture the funds later, you must perform a capture using the payments API. See Captures.
    If you accept more than one payment type and must perform an authorization where funds are collected at a later time, set the
    completeMandate.type
     field to
    PREFER_AUTH
    . You must perform a capture using the payments API when an authorization is performed. A capture is performed automatically if an authorization is not allowed by the payment type.
  3. Include these required fields in the capture context request:
    • orderInformation.billTo.email
    • orderInformation.billTo.firstName
    • orderInformation.billTo.lastName
    • orderInformation.billTo.address1
    • orderInformation.billTo.locality
    • orderInformation.billTo.postalCode
    • orderInformation.billTo.administrativeArea
    • orderInformation.billTo.country
  4. Include these optional fields in the capture context request:
    IMPORTANT
    These fields are required when the
    requestShipping
     fild is set to
    true
    .
    • orderInformation.shipTo.firstName
    • orderInformation.shipTo.lastName
    • orderInformation.shipTo.address1
    • orderInformation.shipTo.locality
    • orderInformation.shipTo.postalCode
    • orderInformation.shipTo.administrativeArea
    • orderInformation.shipTo.country