{"title":"Affirm for API only","category":"default","creationDate":1776961628,"content":"

Accept Affirm payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.<\/p>\n

When making an Affirm payment, you also need to:<\/p>\n

    \n
  1. Provide details about the items being purchased when making a payment request<\/a>.<\/li>\n
  2. Capture<\/a> the payment after the transaction has been fulfilled. When the payment has been captured, Affirm starts the repayment period for the shopper.<\/li>\n<\/ol>\n

    Requirements<\/h2>\n\n\n\n\n\n\n
    Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    Integration type<\/strong><\/td>\nMake sure that you have built an API-only integration<\/a>. <\/td>\n<\/tr>\n
    Setup steps<\/strong><\/td>\nBefore you begin, add Affirm in your test Customer Area<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Build your payment form for Affirm<\/h2>\n

    To make an Affirm payment, you need to collect the following shopper details:<\/p>\n\n\n\n\n\n\n\n\n\n\n
    Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    firstName<\/code><\/td>\nShopper's first name.<\/td>\n<\/tr>\n
    lastName<\/code><\/td>\nShopper's last name.<\/td>\n<\/tr>\n
    telephoneNumber<\/code><\/td>\nShopper's phone number.<\/td>\n<\/tr>\n
    shopperEmail<\/code><\/td>\nShopper's email address.<\/td>\n<\/tr>\n
    billingAddress<\/code><\/td>\nThe address where to send the invoice.<\/td>\n<\/tr>\n
    deliveryAddress<\/code><\/td>\nThe address where the purchased goods should be delivered.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n

    We provide an Affirm logo which you can use in your payment form. For more information, refer to Downloading logos<\/a>.<\/p>\n<\/div>\n

    Make a payment<\/h2>\n

    From your server, make a \/payments<\/a> request, specifying:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter name<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    paymentMethod.type<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nSet to affirm<\/strong><\/span>.<\/td>\n<\/tr>\n
    shopperName<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nShopper's first name and last name.<\/td>\n<\/tr>\n
    telephoneNumber<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe shopper's phone number.<\/td>\n<\/tr>\n
    shopperEmail<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe shopper's email address.<\/td>\n<\/tr>\n
    shopperReference<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nA unique reference to identify the shopper (minimum length three characters).<\/td>\n<\/tr>\n
    countryCode<\/a><\/td>\n<\/td>\nThe shopper's country in two-letter ISO 3166-1 alpha-2<\/a> format.
    Required when transacting in Canada or the United Kingdom, because the default US<\/strong><\/span> is used if you omit this parameter.<\/div><\/div><\/td>\n<\/tr>\n
    billingAddress<\/a><\/td>\n<\/td>\nThe address where to send the invoice. The stateOrProvince<\/code> address field is required for Canada and the US, and optional for the UK.<\/td>\n<\/tr>\n
    deliveryAddress<\/a><\/td>\n<\/td>\nThe address where the purchased goods should be delivered. The stateOrProvince<\/code> address field is required for Canada and the US, and optional for the UK.
    If blank or missing, billingAddress<\/code> is used by default.<\/td>\n<\/tr>\n
    lineItems<\/a><\/td>\n<\/td>\nPrice and product information about the purchased items. This is optional, but we recommend to include this data to improve approval rates.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n

    In the \/payments<\/a> response, check the action<\/code> object for the information that you must use to redirect the shopper.<\/p>\n

    \n <\/code-sample>\n<\/div>\n

    Handle the redirect<\/h2>\n
      \n
    1. \n

      To complete the payment, redirect the shopper to the action.url<\/code> returned in the \/payments<\/a> response, taking into account the following recommendations:<\/p>\n