---
title: "Pagsmile"
slug: "pagsmile"
updated: 2026-05-06T07:56:42Z
published: 2026-05-06T07:56:42Z
canonical: "docs.apcopay.com/pagsmile"
---

> ## 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.

# Pagsmile

## Supported Transaction Types

- [ ] Authorisation
- [ ] Capture
- [x] Purchase
- [ ] Refund
- [x] Withdrawal
- [ ] Void

## Integrations Supported

**Deposit**

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

**Withdrawal**

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

Official Logo:![](https://cdn.document360.io/358ada76-9dff-4d31-80ba-dad90c84bfa9/Images/Documentation/image(47).png)

## Currencies & Countries Supported

| Title | Description |
| --- | --- |
| **Currencies Supported** | Brazil, Mexico, Colombia, Chile, Peru |

## Additional attributes to process Pagsmile

You must include the following JSON Attributes to the payload. These attributes inform us to redirect to Pagsmile to finalize the payment process.

| Description | Hosted Payment Page | Direct Connect (Withdrawals) |
| --- | --- | --- |
| **Transaction type** | "TransactionType": "PURC", | "TransactionType": "ORIGINALCREDIT", |
| **Client** | "Client": { **"Email": "test@email.com",** "FirstName": "John", "LastName": "Doe", "Country": "NGA", "MobileNo": "10449262289", "Street": "Street Name, 1", "City": "London", "IPAddress": "127.0.0.1" }, | "Client": { **"Email": "test@email.com",** **"FirstName": "John",** **"LastName": "Doe",** "Country": "NGA", "MobileNo": "10449262289", "Street": "Street Name, 1", "City": "London", "IPAddress": "127.0.0.1" }, |
| **Force Transaction Routing** | "Routing": { "ForcePayment": "PAGSMILE" }, |
| **Payment Method Data** | "PaymentMethodData":{ "PaymentMethod": "lottery", "DocumentNumber": "50284414727", "DocumentType": "CPF", "ArrivalCurrency": "BRL" |  |
| **Payment Destination** |  | "PaymentDestination": { "PaymentMethodData": { "PayoutType": "brazil-pix", "DocumentNumber": "50284414727", "DocumentType": "CPF", "ArrivalCurrency": "BRL", "PayoutAccountType": "EMAIL" } |
| **Test Indicator** (required in Sandbox Environment only) | "IsTest": True |

**Sample Deposit Request**

Refer to our API Reference Document [here](https://apcopay.redoc.ly/#tag/Hosted-Payment-Page) to create a Hosted Payment Page, use the below mandatory tags to process a deposit.

Below is a sample deposit request.

```json
{
  "TransactionType": "PURC",
  "Amount": "2000.00",
  "Currency": "BRL",
  "OrderReference": "Hello World",
  "RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
  "Language": "pt",
  "Client": {
    "FirstName": "Apco",
    "LastName": "Test",
    "Email": "Apco@Test.com",
    "ClientAccount": "321",
    "City": "Rio de Janeiro",
    "ZIPCode": "00000",
    "State": "RJ",
    "Street": "Street",
    "Country": "BR",
    "MobileNo": "9999999",
    "IPAddress": "127.0.0.0.1"
  },
  "PaymentMethodData":{
    "PaymentMethod": "lottery",
    "DocumentNumber": "50284414727",
    "DocumentType": "CPF",
    "ArrivalCurrency": "BRL"
  },
  "OrderDescription": "Test",
  "Routing": {
    "ForcePayment": "PAGSMILE"
  },
  "IsTest": "True"
}
```

**Withdrawals**

Withdrawals are processed via Direct Connect. The API reference to request a payout can be found [here](https://apcopay.redoc.ly/#operation/PaymentOperationAUTHPURC).

Below is a sample Withdrawal request.

```json
{
  "TransactionType": "ORIGINALCREDIT",
  "Amount": "200.00",
  "Currency": "BRL",
  "OrderReference": "MerchantOrder1",
  "RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
  "CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
  "Routing": {
    "ForcePayment": "PAGSMILE"
  },
  "IsTest": true,
  "PaymentDestination": {
    "PaymentMethodData": {
      "PayoutType": "brazil-pix",
      "DocumentNumber": "50284414727",
      "DocumentType": "CPF",
      "ArrivalCurrency": "BRL",
      "PayoutAccountType": "EMAIL"
    }
  },
  "Client": {
    "FirstName": "Apco",
    "LastName": "Test",
    "Email": "Apco@Test.com",
    "ClientAccount": "apco@test.com",
    "City": "Rio de Janeiro",
    "ZIPCode": "00000",
    "State": "RJ",
    "Street": "Street",
    "Country": "BR",
    "MobileNo": "9999999",
    "IPAddress": "127.0.0.0.1"
  }
}
```

**Functionalities - Available payment methods**

Registration Country : **Brazil**

| **Bank Code** | **Method** |
| --- | --- |
| BOLETO | Boleto |
| DEPOSITEXPRESS | Deposit Express |
| LOTTERY | Lottery |
| WALLET (ChannelMethod : PICPAY) | PicPay Wallet |
| WALLET (ChannelMethod : AME) | AME Wallet |
| WALLET (ChannelMethod : PAYPAL) | PAYPAL Wallet |
| PIX | PIX |

Registration Country : **Mexico**

| **Bank Code** | **Method** |
| --- | --- |
| OXXO | OXXO |
| SPEI | SPEI |
| WALLET (ChannelMethod : TODITO) | TODITO Wallet |
| CASH | Cash |

Registration Country : **Colombia**

| **Bank Code** | **Method** |
| --- | --- |
| BANKTRANSFER | Bank Transfer |
| CASH | CASH |
| PSE | PSE |
| EFECTY | EFECTY |

Registration Country : **Chile**

| **Bank Code** | **Method** |
| --- | --- |
| BANKTRANSFER | Bank Transfer |
| CASH | CASH |
| KHIPU | KHIPU |

Registration Country : **Peru**

| **Bank Code** | **Method** |
| --- | --- |
| BANKTRANSFER | Bank Transfer |
| CASH | CASH |
| BANKTRANSFER | Bank Transfer |

##