---
title: "PIX"
slug: "pix"
updated: 2025-02-19T15:49:17Z
published: 2025-02-19T15:49:17Z
canonical: "docs.apcopay.com/pix"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apcopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PIX

PIX is a widely popular payment method in Brazil, known for its convenience and speed. Developed by the Central Bank of Brazil, it allows instant, 24/7 money transfers using simple identifiers like phone numbers, email addresses, or unique PIX keys. Since its launch, PIX has become essential for everyday transactions, from person-to-person transfers to payments for goods and services, making it a preferred choice across the country.

### Supported Transaction Types

- [ ] Authorisation
- [x] Purchase
- [ ] Capture
- [ ] Void
- [ ] Refunds
- [x] Withdrawals

### Integrations Supported

**Deposit**

- [x] Hosted Payment Page
- [ ] Direct Connect

**Withdrawal**

- [ ] Hosted Payment Page
- [x] Direct Connect ( server-to-server)

### Currencies & Countries Supported

| Title | Description |
| --- | --- |
| Currencies Supported | BRL |
| Countries Supported | Brazil |

## Additional attributes to process Cards via Monetix

You must include the following JSON Attributes to the payload. These attributes inform us to proceed with the redirection to finalise the payment process.

| Description | Hosted Payment Page | **Direct Connect (Withdrawals only)** |
| --- | --- | --- |
| **Transaction type** | "TransactionType": "PURC", | "TransactionType": "ORIGINALCREDIT", |
| **Force Transaction Routing** | “Routing”:{ "ForcePayment": "MONETIX” } | “Routing”:{ "ForcePayment": "MONETIX” } |
| **Client Details** | "Client": { "FirstName": "Joe", "LastName": "Borg", "Street": "12 Church street", "City": "Valletta", "Email": "[TestEmail@Email.com](mailto:TestEmail@Email.com)", "ClientAccount": "testing", "IPAddress":"1.1.1.1" "DateOfBirth":"2000-10-10" } | Client": { "FirstName": "Joe", "LastName": "Borg", "Street": "12 Church street", "City": "Valletta", "Email": "[TestEmail@Email.com](mailto:TestEmail@Email.com)", "ClientAccount": "testing", "IPAddress":"1.1.1.1" "DateOfBirth":"2000-10-10" } |
| **Payment Method Data** | "PaymentMethodData": { "PaymentMethod": "PIX" "DocumentNumber":"91175478067", "RecipientPixKey":"91175478067" }, | "PaymentDestination": { "PaymentMethod": "AlternativePaymentMethods", "PaymentMethodData": { "PaymentMethod": "PIX", "DocumentNumber":"91175478067", "RecipientPixKey":"91175478067", "BeneficiaryAccountNumber":"233123456789" } }, |
| **Test Indicator** (required in Sandbox Environment only) | "isTest”: true | "isTest”: true |

**Sample request for Deposit**

```json
{
  "TransactionType": "PURC",
  "Amount": 100.00,
  "Currency": "BRL",
  "OrderReference": "Monetix PIX test",
  "UniqueReference": "3a9f50f7-2deb-4dbf-a186-d58641s36665",
  "RedirectionURL": "https://www.yourURLhere.com/Redirect/",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "Routing": {
    "ForcePayment": "MONETIX"
  },
 "IsTest": true,
 "Client": {
    "FirstName": "Joe",
    "LastName": "Borg",
    "City": "TestCity",
    "Street": "fakestreet 123",
    "Email": "TestEmail@Email.com",
    "ClientAccount": "testing",
    "IPAddress": "1.1.1.1",
    "MobileNo":"123456",
    "DateOfBirth":"2000-10-10"
  },
  "PaymentMethodData": {
    "PaymentMethod": "PIX",
    "DocumentNumber":"91175478067",
    "RecipientPixKey":"91175478067"
  }
}
```

**Sample request for a Payout**

```json
{
  "TransactionType": "ORIGINALCREDIT",
  "Amount": "100.00",
  "Currency": "BRL",
  "OrderReference": "Monetix payout test",
  "UniqueReference": "3a9f50f7-2deb-4dbf-a186-d58651s36665",
  "IsTest": true,
  "RedirectionURL": "https://www.yourURLhere.com/Redirect",
  "CallBackURL": "https://www.yourURLhere.com/Listener",
  "Routing": {
    "ForcePayment": "MONETIX"
  }
  "Client": {
    "FirstName": "Joe",
    "LastName": "Borg",
    "City": "TestCity",
    "Email": "TestEmail@Email.com",
    "Street": "fakestreet 123",
    "ClientAccount": "testing",
    "IPAddress": "1.1.1.1",
    "MobileNo":"123456",
    "DateOfBirth":"2000-10-10"
  },
  "PaymentDestination": {
    "PaymentMethod": "AlternativePaymentMethods",
    "PaymentMethodData": {
       "PaymentMethod": "PIX",
       "DocumentNumber":"91175478067",
       "RecipientPixKey":"91175478067",
       "BeneficiaryAccountNumber":"233123456789"
    }
  }
}
```