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

You can add Pix to your existing integration. The following instructions show only what you must add to your integration specifically for Pix.<\/p>\n

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to the corresponding step of the main integration guide.<\/p>\n

Requirements<\/h2>\n\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 an existing API-only integration<\/a>.<\/td>\n <\/td>\n<\/tr>\n
Action handling<\/strong><\/td>\nMake sure that your existing integration is set up to handle the additional action<\/a>.
action.type<\/code>: qrCode<\/strong>.<\/td>\n		<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\n Before you begin, add Pix in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

How it works<\/h2>\n
    \n
  1. The shopper selects Pix as the payment method.<\/li>\n
  2. The shopper enters their details in the payment form that you build<\/a>.<\/li>\n
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n
  4. Your existing integration setup<\/a> enables you to present a QR code to the shopper to complete the payment.<\/li>\n
  5. You capture the payment<\/a>.<\/li>\n<\/ol>\n

    Build your payment form<\/h2>\n

    Include fields to collect the following information from your shopper in the payment form.<\/p>\n\n\n\n\n\n\n
    Field<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    Name<\/strong><\/span><\/td>\nThe first and last name of the shopper.<\/td>\n<\/tr>\n
    CPF\/CNPJ<\/strong><\/span><\/td>\nCPF\/CNPJ is a unique identifier similar to a social security number. The shopper can provide their CPF<\/strong><\/span> (Cadastro de Pessoas F\u00edsicas) number or their CNPJ<\/strong><\/span> (Cadastro Nacional da Pessoa Jur\u00eddica) number.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Pass the collected data from the front end to your server because you need to submit both Name and CPF\/CNPJ in the \/payments<\/a> request. Show this information to the shopper together with the QR code to help identify the payment.<\/p>\n

    \n

    You can download the logo for Pix<\/a> to use in your form.<\/p>\n<\/div>\n

    Get Pix as an available payment method<\/h2>\n

    When you make the \/paymentMethods<\/a> request to get available payment methods<\/a>, specify the following so that Pix is included in the response.<\/p>\n\n\n\n\n\n\n
    Parameter<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
    countryCode<\/a><\/td>\nBR<\/strong><\/td>\n<\/tr>\n
    amount.currency<\/a><\/td>\nBRL<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n
    \n <\/code-sample>\n<\/div>\n

    Add additional parameters to your \/payments request<\/h2>\n

    When you make a payment<\/a>, add the following parameters:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    paymentMethod<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe state.data.paymentMethod<\/code> from the onSubmit<\/code> event from your front end.<\/td>\n<\/tr>\n
    amount<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nThe final price of the purchase.<\/td>\n<\/tr>\n
    shopperName<\/a><\/td>\n<\/td>\nShopper's first name and last name.<\/td>\n<\/tr>\n
    socialSecurityNumber<\/a><\/td>\n<\/td>\nThe shopper's CPF or CNPJ number. This will be shown to the shopper on the Pix payment form.<\/td>\n<\/tr>\n
    shopperStatement<\/a><\/td>\n<\/td>\nFree-text field that will be shown to the shopper. By default this contains the message: $merchantName - Este pagamento PIX para $merchantName \u00e9 processado por Adyen.<\/em> If you provide any value, keep the length under 60 characters.<\/td>\n<\/tr>\n
    sessionValidity<\/a><\/td>\n<\/td>\nThe expiration date of the Pix payment. Default: 1 hour (Checkout API v71 or earlier) or 24 hours (Checkout API v72 or later). Maximum: 5 days, in ISO 8601<\/a> format. Example: 2020-07-18T15:42:40.428+01:00<\/td>\n<\/tr>\n
    lineItems.id<\/a><\/td>\n<\/td>\nThe name of the purchased item. Maximum 50 characters.<\/td>\n<\/tr>\n
    lineItems.amountIncludingTax<\/a><\/td>\n<\/td>\nThe price of the purchased item including tax. Maximum 200 characters.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n

    It is advisable to send both shopperName<\/code> and socialSecurityNumber<\/code>, because this information will be shown to the shopper to help identify the payment.<\/p>\n<\/div><\/div>\n

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

    The response includes the action.type<\/code>: qrCode<\/strong>.<\/p>\n

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

    Example webhook:<\/p>\n

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

    For more information, see Webhooks<\/a>.<\/p>\n

    You can include the following fields in your payment confirmation:<\/p>\n