APM buttons

Sign in Hub
Get help
APM buttons
Add alternative payment method buttons to your payment form with customizable styling, placement, and method-specific display conditions

Alternative payment method buttons add payment options alongside card checkout.

Button configuration is passed during Guide
Initialize the payment form by providing the init object and form parameters. form initialization alongside formParams. For Guide
Handle APM payment operations from initiation through settlement using consistent patterns for captures, refunds, and void actions. future payments, include future_usage in paymentIntent. Track lifecycle through payment form Guide
Subscribe to payment form lifecycle events to track user interactions, validate input, handle errors, and respond to payment completion. events.

When using init payment API v1 , do not create multiple buttons with the same order_id at once. If you are already using a host-to-host APM button, disable it so orders are created and processed automatically by the payment form.

If you have not set up an APM button for your channels, contact us.


Setup workflow
anchor

Every APM button follows the same three-step setup.

  1. Configure the payment method.
  2. Build the paymentIntent with the fields below. Add method-specific objects from your method tab.

Billing flow
anchor

Pass Billing-specific fields in the Guide
Pass Billing-specific fields in paymentIntent for catalog products, subscriptions, and invoices. billing flow paymentIntent for catalog products, subscriptions, and invoices. Match the scenario to your Billing version.

The paymentIntent object lists fields the APM button needs. Combine both on the same intent. Subscription 2.0 and Invoice omit top-level amount, currency, and product_id.


  1. Pass the method params object to PaymentFormSdk.init with enabled true . Without containerId, the button renders above the form. A non-existent containerId produces a console error.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

const data = {
  merchantData: {
    merchant: "<-your data->",
    signature: "<-your data->",
    paymentIntent: "<-your data->",
  },
  // Replace with your method's params object: bizumButtonParams, blikButtonParams,
  // cashAppButtonParams, gcashButtonParams, mbwayButtonParams, paypalButtonParams,
  // pixAutomaticoButtonParams, pixQrButtonParams, pixButtonParams (SmartPix), or upiButtonParams.
  bizumButtonParams: {
    enabled: true,
    containerId: "your-custom-container-id"
  }
};

let form = PaymentFormSdk.init(data);

Subscribe to the mounted Guide
Subscribe to payment form lifecycle events to track user interactions, validate input, handle errors, and respond to payment completion. event to know when a button is rendered. Entity names follow bizumbtn , blikbtn (one-time and recurring), pixautomaticobtn , smartpixbtn , upibtn , etc.


Method-specific configuration
anchor

Select your APM to see its paymentIntent payload, button params, and init snippet.

DISPLAYED BY DEFAULT
Bizum · Cash App Pay · PayPal · SmartPix

Bizum is a Spanish peer-to-peer bank payment.

  • currency EUR
  • geo_country ESP
  • future_usage Required
  • billing_address.country Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 1020,
  "currency": "EUR",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "one-time"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+34911012345",
  "ip_address": "8.8.8.8",
  "geo_country": "ESP",
  "platform": "WEB",
  "language": "es",
  "billing_address": {
    "country": "ESP"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        bizumButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId'
        }
    });
</script>

Cash App Pay is a US digital wallet.

  • currency USD
  • geo_country USA Required
  • future_usage Required
  • success_url Required
  • fail_url Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

{
  "order_id": "123456",
  "amount": 2500,
  "currency": "USD",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "one-time"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "ip_address": "8.8.8.8",
  "geo_country": "USA",
  "platform": "WEB",
  "language": "en",
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        cashAppButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId'
        }
    });
</script>

PayPal is a worldwide multi-currency wallet checkout.

  • customer_email autogenerated if missing, confirmed on PayPal login
  • Billing 2.0 Guide
    Pass Billing-specific fields in paymentIntent for catalog products, subscriptions, and invoices.     checkout     passes checkout and omits amount, currency, and product_id
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "order_id": "123456",
  "amount": 1020,
  "currency": "USD",
  "order_description": "Premium package",
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "ip_address": "8.8.8.8",
  "geo_country": "USA",
  "platform": "WEB",
  "language": "en",
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "USD",
  "order_description": "Premium package",
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "ip_address": "8.8.8.8",
  "geo_country": "USA",
  "platform": "WEB",
  "language": "en",
  "retry_attempt": 1,
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "order_description": "Premium package",
  "checkout": {
    "mode": "subscription",
    "customer_id": "cust_01KMG2ABYPF6XS5DMJQ817C429",
    "merchant_reference": "order_ABC-123",
    "line_items": [
      {
        "product_price_id": "fa43b415-5522-4373-b026-a365562f9649",
        "quantity": 1
      }
    ]
  },
  "customer_email": "test@solidgate.com",
  "ip_address": "8.8.8.8",
  "geo_country": "USA",
  "platform": "WEB",
  "language": "en",
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "order_id": "123456",
  "order_description": "Premium package",
  "checkout": {
    "mode": "invoice",
    "customer_id": "cust_01KMG2ABYPF6XS5DMJQ817C429",
    "merchant_reference": "order_ABC-123",
    "line_items": [
      {
        "product_price_id": "fa43b415-5522-4373-b026-a365562f9649",
        "quantity": 2,
        "description": "Premium plan"
      }
    ]
  },
  "customer_email": "test@solidgate.com",
  "ip_address": "8.8.8.8",
  "geo_country": "USA",
  "platform": "WEB",
  "language": "en",
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

const data = {
  merchantData: {
    merchant: "<-your data->",
    signature: "<-your data->",
    paymentIntent: "<-your data->",
  },
  paypalButtonParams: {
    enabled: true,
    color: "blue",
    shape: "rect",
    label: "checkout",
    height: 52,
    disableMaxWidth: true
  }
};

let form = PaymentFormSdk.init(data);

SmartPix collects one-time or recurring Brazilian payments via Open Finance bank connections.

  • currency BRL
  • geo_country BRA
  • billing_address.country Required
  • payment_type_data.brazil_cpf Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 1020,
  "currency": "BRL",
  "order_description": "Premium package",
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+5511987654321",
  "ip_address": "8.8.8.8",
  "geo_country": "BRA",
  "platform": "WEB",
  "language": "pt",
  "billing_address": {
    "country": "BRA"
  },
  "payment_type_data": {
    "brazil_cpf": "12345678901"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "BRL",
  "order_description": "Premium package",
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+5511987654321",
  "ip_address": "8.8.8.8",
  "geo_country": "BRA",
  "platform": "WEB",
  "language": "pt",
  "billing_address": {
    "country": "BRA"
  },
  "payment_type_data": {
    "brazil_cpf": "12345678901"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        pixButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            resetEnabled: true
        }
    });
</script>

OPT-IN REQUIRED  ·  enabled true
BLIK (one time and recurring) · GCash · MB WAY · Pix Automático · Pix QR · UPI Intent

BLIK One-time is a Polish mobile payment with one-time authorization codes.

  • currency PLN
  • geo_country POL
  • payment_method_flow redirect
  • future_usage Required
  • billing_address.country Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 5000,
  "currency": "PLN",
  "order_description": "Premium package",
  "payment_method_flow": "redirect",
  "future_usage": {
    "payment_type": "one-time"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "ip_address": "8.8.8.8",
  "geo_country": "POL",
  "platform": "WEB",
  "language": "pl",
  "billing_address": {
    "country": "POL"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        blikButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            theme: 'light',
            resetEnabled: true
        }
    });
</script>

BLIK Recurring sets up a recurring mandate and processes the initial charge.

  • currency PLN
  • geo_country POL
  • payment_method_flow direct
  • future_usage Required
  • billing_address.country Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 5000,
  "currency": "PLN",
  "order_description": "Monthly Premium Plan",
  "payment_method_flow": "direct",
  "future_usage": {
    "payment_type": "unscheduled"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "ip_address": "8.8.8.8",
  "geo_country": "POL",
  "platform": "WEB",
  "language": "pl",
  "billing_address": {
    "country": "POL"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "PLN",
  "order_description": "Monthly Premium Plan",
  "payment_method_flow": "direct",
  "future_usage": {
    "payment_type": "unscheduled"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "ip_address": "8.8.8.8",
  "geo_country": "POL",
  "platform": "WEB",
  "language": "pl",
  "billing_address": {
    "country": "POL"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

This button shares its blikButtonParams object with BLIK One-time. Enabling it lets customers pay with recurring BLIK too. Find the object and init snippet on the BLIK One-time tab.

GCash is a Philippine e-wallet payment. The form asks the customer for the email, full name, and phone number that are not passed in the paymentIntent, and the customer authorizes the payment in the GCash wallet.

  • currency PHP
  • future_usage Required
  • billing_address.country Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "order_id": "123456",
  "amount": 2575,
  "currency": "PHP",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "one-time"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+639171234567",
  "ip_address": "8.8.8.8",
  "platform": "WEB",
  "language": "en",
  "billing_address": {
    "country": "PHL"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "order_id": "123456",
  "amount": 2575,
  "currency": "PHP",
  "order_description": "Monthly Premium Plan",
  "future_usage": {
    "payment_type": "unscheduled"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+639171234567",
  "ip_address": "8.8.8.8",
  "platform": "WEB",
  "language": "en",
  "billing_address": {
    "country": "PHL"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        gcashButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId'
        }
    });
</script>

Klarna is a global wallet checkout with pay now, pay later, and financing options on the Klarna.

  • future_usage Required
  • billing_address country Required
  • item_category digital_goods or physical_goods Required
  • customer_email Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "order_kln_001",
  "amount": 9900,
  "currency": "EUR",
  "order_description": "Order #kln_001",
  "future_usage": {
    "payment_type": "one-time"
  },
  "customer_email": "buyer@example.com",
  "customer_first_name": "Emma",
  "customer_last_name": "Johansson",
  "customer_phone": "+46701234567",
  "ip_address": "82.115.34.21",
  "geo_country": "SWE",
  "platform": "WEB",
  "language": "en",
  "billing_address": {
    "country": "SWE",
    "city": "Stockholm",
    "zip_code": "111 57"
  },
  "item_category": "digital_goods",
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

{
  "order_id": "order_kln_rec_001",
  "amount": 9900,
  "currency": "EUR",
  "order_description": "Monthly subscription",
  "future_usage": {
    "payment_type": "recurring",
    "billing_amount": 9900,
    "billing_period": {
      "unit": "month",
      "value": 1
    }
  },
  "customer_email": "buyer@example.com",
  "customer_first_name": "Emma",
  "customer_last_name": "Johansson",
  "customer_phone": "+46701234567",
  "ip_address": "82.115.34.21",
  "geo_country": "SWE",
  "platform": "WEB",
  "language": "en",
  "billing_address": {
    "country": "SWE",
    "city": "Stockholm",
    "zip_code": "111 57"
  },
  "item_category": "digital_goods",
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        klarnaButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            theme: 'light',
            shape: 'pill'
        }
    });
</script>

MB WAY is a Portuguese mobile payment.

  • currency EUR
  • geo_country PRT
  • future_usage Required
  • billing_address.country Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 1020,
  "currency": "EUR",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "one-time"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+351912345678",
  "ip_address": "8.8.8.8",
  "geo_country": "PRT",
  "platform": "WEB",
  "language": "pt",
  "billing_address": {
    "country": "PRT"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 1020,
  "currency": "EUR",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "1-click"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+351912345678",
  "ip_address": "8.8.8.8",
  "geo_country": "PRT",
  "platform": "WEB",
  "language": "pt",
  "billing_address": {
    "country": "PRT"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "EUR",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "recurring"
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+351912345678",
  "ip_address": "8.8.8.8",
  "geo_country": "PRT",
  "platform": "WEB",
  "language": "pt",
  "billing_address": {
    "country": "PRT"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        mbwayButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            theme: 'dark'
        }
    });
</script>

Pix Automático is a BCB-regulated recurring mandate in Brazil. The button initiates the mandate and first charge.

The button is available only for product-based initialization: pass product_id together with future_usage.max_amount. The billing interval comes from the product configuration and must follow the allowed Guide
Allowed billing intervals for Pix Automático mandates per BCB rules. billing periods . The Guide
How max_amount and product_id define the per-charge authorization limit. authorization ceiling is set by future_usage.max_amount and product_id .

With product_id, use a product without a trial or with a trial of at least 2 days. With a 1-day trial, the button is not shown.

  • currency BRL
  • geo_country BRA
  • product_id Required
  • future_usage.max_amount Required
  • billing_address.country Required
  • payment_type_data.brazil_cpf Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "BRL",
  "order_description": "Premium package",
  "future_usage": {
    "payment_type": "recurring",
    "max_amount": 10000
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+5511987654321",
  "ip_address": "8.8.8.8",
  "geo_country": "BRA",
  "platform": "WEB",
  "language": "pt",
  "retry_attempt": 1,
  "billing_address": {
    "country": "BRA"
  },
  "payment_type_data": {
    "brazil_cpf": "12345678901"
  },
  "order_metadata": {
    "campaign": "pix_automatico_launch",
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "BRL",
  "order_description": "Premium package",
  "future_usage": {
    "max_amount": 10000
  },
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+5511987654321",
  "ip_address": "8.8.8.8",
  "geo_country": "BRA",
  "platform": "WEB",
  "language": "pt",
  "retry_attempt": 1,
  "billing_address": {
    "country": "BRA"
  },
  "payment_type_data": {
    "brazil_cpf": "12345678901"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        pixAutomaticoButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            resetEnabled: true
        }
    });
</script>

Pix QR is a single-use Brazilian payment. Solidgate returns a QR code that the customer scans in their banking app.

  • currency BRL
  • geo_country BRA
  • billing_address.country Required
  • payment_type_data.brazil_cpf Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "order_id": "123456",
  "amount": 1020,
  "currency": "BRL",
  "order_description": "Premium package",
  "customer_email": "test@solidgate.com",
  "customer_first_name": "John",
  "customer_last_name": "Snow",
  "customer_phone": "+5511987654321",
  "ip_address": "8.8.8.8",
  "geo_country": "BRA",
  "platform": "WEB",
  "language": "pt",
  "billing_address": {
    "country": "BRA"
  },
  "payment_type_data": {
    "brazil_cpf": "12345678901"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        pixQrButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            resetEnabled: true
        }
    });
</script>

UPI Intent launches the customer's UPI app on mobile or displays a QR code on desktop.

With product_id, use a product without a trial or with a trial equal to the billing period.

  • currency INR
  • geo_country IND
  • payment_method_flow redirect
  • future_usage.payment_type
    • unscheduled for one-time, do not pass future_usage.billing_period.
    • recurring for recurring, future_usage.max_amount, and future_usage.billing_period Required
  • billing_address.country and billing_address.zip_code Required 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

{
  "order_id": "123456",
  "amount": 29900,
  "currency": "INR",
  "order_description": "Premium package",
  "payment_method_flow": "redirect",
  "future_usage": {
    "payment_type": "unscheduled"
  },
  "customer_account_id": "4dad42f808",
  "customer_email": "buyer@example.in",
  "customer_first_name": "Arjun",
  "customer_last_name": "Sharma",
  "customer_phone": "+919876543210",
  "ip_address": "8.8.8.8",
  "geo_country": "IND",
  "platform": "WEB",
  "billing_address": {
    "country": "IND",
    "zip_code": "110001"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

{
  "order_id": "123456",
  "product_id": "ac43b415-5522-4373-b026-a365462f9657",
  "customer_account_id": "4dad42f808",
  "currency": "INR",
  "order_description": "Premium package",
  "payment_method_flow": "redirect",
  "future_usage": {
    "payment_type": "unscheduled"
  },
  "customer_email": "buyer@example.in",
  "customer_first_name": "Arjun",
  "customer_last_name": "Sharma",
  "customer_phone": "+919876543210",
  "ip_address": "8.8.8.8",
  "geo_country": "IND",
  "platform": "WEB",
  "billing_address": {
    "country": "IND",
    "zip_code": "110001"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

{
  "order_id": "123456",
  "amount": 29900,
  "currency": "INR",
  "order_description": "Monthly subscription",
  "payment_method_flow": "redirect",
  "future_usage": {
    "payment_type": "recurring",
    "max_amount": 99900,
    "billing_period": {
      "unit": "month",
      "value": 1
    }
  },
  "customer_account_id": "4dad42f808",
  "customer_email": "buyer@example.in",
  "customer_first_name": "Arjun",
  "customer_last_name": "Sharma",
  "customer_phone": "+919876543210",
  "ip_address": "8.8.8.8",
  "geo_country": "IND",
  "platform": "WEB",
  "billing_address": {
    "country": "IND",
    "zip_code": "110001"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "order_id": "123456",
  "product_id": "47f95c95-3647-4c5b-ae6d-40fd8d3ac742",
  "customer_account_id": "4dad42f808",
  "currency": "INR",
  "order_description": "Premium package",
  "payment_method_flow": "redirect",
  "future_usage": {
    "payment_type": "recurring",
    "max_amount": 99900
  },
  "customer_email": "buyer@example.in",
  "customer_first_name": "Arjun",
  "customer_last_name": "Sharma",
  "customer_phone": "+919876543210",
  "ip_address": "8.8.8.8",
  "geo_country": "IND",
  "platform": "WEB",
  "billing_address": {
    "country": "IND",
    "zip_code": "110001"
  },
  "order_metadata": {
    "partner_id": "123989"
  },
  "success_url": "https://merchant.example/success",
  "fail_url": "https://merchant.example/fail"
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

<div id="yourCustomContainerId"></div>
<script>
    PaymentFormSdk.init({
        ...restData,
        upiButtonParams: {
            enabled: true,
            containerId: 'yourCustomContainerId',
            resetEnabled: true,
            type: 'short'
        }
    });
</script>
Looking for help? Contact us
Stay informed with Changelog