# PIX

**PIX is a bank transfer payment method, built and owned by Brazil's** **Central Bank** **and linked to over 700 Brazilian financial institutions. Shoppers can pay with PIX when shopping online and via** **QR** **codes in-store.**

## **Features**

| Processing currencies      | BRL        |
| -------------------------- | ---------- |
| Settlement currencies      | USD        |
| Minimum transaction amount | 3 BRL      |
| Maximum transaction amount | 14,677 BRL |
| Refunds                    | ✅          |
| Partial Refunds            | ❌          |
| Multiple partial refund    | ❌          |
| Chargeback                 | ❌          |

# **Integration Method**

**Payment method enumeration values:** **`pix`**

**There is integration method for PIX**

1. Direct API
2. Checkout

## **Direct** **API** 

### **How to integration**

For direct API integration, you can create a PaymentIntent and get url in only one step. The following is the demo of creating payment intent:

[**Create a PaymentIntent**](api-42631218)

A PaymentIntent is an object that represents your intent to collect payment from your customer and tracks the lifecycle of the payment process. Create a PaymentIntent on your server and specify the amount to collect and a supported currency. If you have an existing Payment Intents integration, add **`pix`** the list of payment method types.

***Request***  Create a PaymentIntent

```JSON
{
    "amount":1000,
    "currency":"BRL",
    "confirm":true,
    "payment_method_data" : {
        "type":"pix"
        "billing_details":{
            "address": {
                "country": "BR"
            },
            "name": "Tom Elis",
            "email": "1231536GF41@Gmail.com"
        }
    },
    "description": "product description",
    "merchant_order_id": "Order112344343",
    "return_url":"https://your.website"
}
```

***Response***

```JSON
{
    "id": "pi_1745344408523374592",
    "object": "payment_intent",
    "created": 1704957509000,
    "livemode": false,
    "currency": "BRL",
    "amount": 1000,
    "status": "requires_action",
    "description": "product description",
    "merchant_order_id": "Order112344343",
    "client_secret": "pi_1745344408523374592_secret_8RVniIRG2HBKTr0mokq0hwrR",
    "next_action": {
        "type": "pix_handle_redirect",
        "pix_handle_redirect": {
            "url": "https://checkouttest.wooshpay.com/paymentcode?clientSecret=pi_1745344408523374592_secret_8RVniIRG2HBKTr0mokq0hwrR&k1=cGtfdGVzdF9OVEUyTlRjNU5ESXpNalUxTXpNME56ZzVNVE14T2pNemIxTTJhVVZrTmtOdmFsWlBSRTFuVFc1SVREaFljREUyT0RReE1Ua3lNamd6TVRR&c=c14&type=pix&token=60xfSnQ2t-QttOe4WRm3F8cBls0SSRTSf4FN5QKkk1c="
        }
    },
    "payment_method_types": [
        "pix"
    ],
    "confirmation_method": "automatic",
    "return_url": "https://your.website",
    "payment_method": "pm_1745344408435294208",
    "capture_method": "automatic"
}
```

## **Checkout**

### Payment flow

1. Customer selects Pix from the list of payment methods available and clicks on the Pay botton


![下载.png](https://api.apifox.com/api/v1/projects/1296482/resources/417649/image-preview)

2. Customers will be redirected to Pix's page, and approve the payment 

### [Create a Session](api-42654181)

***Request*** 

```JSON
{
    "cancel_url": "www.wooshpay.com",
    "mode": "payment",
    "success_url": "https://wooshpay.com/",
    "payment_method_types": [
        "pix"
    ],
    "line_items": [
        {
            "price_data": {
                "currency": "BRL",
                "unit_amount": 20000,
                "nickname": "apple",
                "product_data": {
                    "id": null,
                    "name": "apple"
                }
            },
            "quantity": 1
        }
    ]
}
```

***Response***

```JSON
{
    "id": "cs_1745349377481768960",
    "object": "checkout.session",
    "created": 1704958693000,
    "livemode": false,
    "currency": "BRL",
    "customer": "",
    "mode": "payment",
    "status": "open",
    "url": "https://checkouttest.wooshpay.com/pay/cs_test_1745349377481768960?key=cGtfdGVzdF9OVEUyTlRjNU5ESXpNalUxTXpNME56ZzVNVE14T2pNemIxTTJhVVZrTmtOdmFsWlBSRTFuVFc1SVREaFljREUyT0RReE1Ua3lNamd6TVRR",
    "cancel_url": "www.wooshpay.com",
    "line_items": {
        "object": "list",
        "data": [
            {
                "id": "li_1745349377502740480",
                "object": "item",
                "currency": "BRL",
                "description": "apple",
                "price": {
                    "id": "price_1745349377511129088",
                    "object": "price",
                    "created": 1704958693000,
                    "livemode": false,
                    "active": false,
                    "currency": "BRL",
                    "nickname": "apple",
                    "product": "prod_1745349377519517696",
                    "type": "one_time",
                    "unit_amount": 20000
                },
                "quantity": 1,
                "amount_subtotal": 20000,
                "amount_total": 20000
            }
        ]
    },
    "payment_intent": "pi_1745349382124863488",
    "payment_method_types": [
        "pix"
    ],
    "payment_status": "unpaid",
    "success_url": "https://wooshpay.com/",
    "amount_subtotal": 20000,
    "amount_total": 20000,
    "billing_address_collection": "auto",
    "expires_at": 1705045093276,
    "payment_link": "",
    "client_secret": "pi_1745349382124863488_secret_4zzY2IQsRmMx9b2Vyk5TgHmF"
}
```

# **Next step**

You can add more features to your integration as needed

## [Create a Webhook](doc-2517709)

Listen to events on your WooshPay account so your integration can automatically trigger reactions. Create a webhook that mainly focuses on enabled_events and url.

## [Create a Refund](api-51369554)

Create a refund to repay funds to your customer. You can also perform partial refunds, but not every payment method supports them. A partial refund is when you refund only part of the original transaction amount.