Pagsmile

https://docs.pagsmile.com/
Admin
Pagsmile provides global payment processing and remittance solutions, enabling merchants to accept...
Tokens:1,012,219
Snippets:4,387
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Submit Payin Request Example

Source: https://docs.pagsmile.com/reference/payin/submit-a-payin/taiwan/wallet.md

A cURL command example for submitting a Wallet payin request.

```bash
curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "162************38",
    "out_trade_no": "202201010354006",
    "method": "Wallet",
    "channel": "LINEPay", //LINEPay or Jkopay
    "order_amount": "300",
    "order_currency": "TWD",
    "subject": "trade pay test",
    "content": "trade pay test conent",
    "notify_url": "http://merchant/callback/success",
    "return_url": "https://www.merchant.com",
    "buyer_id": "buyer_0101_0001",
    "timestamp": "2022-01-01 03:54:01",
    "timeout_express":"300m"
    }'
```

--------------------------------

### Request Sample (curl)

Source: https://docs.pagsmile.com/reference/payin/tools/installment-detail-query.md

Example curl command to POST to the installment detail query endpoint. Requires Basic authentication with Base64-encoded app_id and security_key, and a JSON body with app_id, timestamp, amount, and currency.

```bash
curl --location --request POST 'https://gateway.pagsmile.com/trade/installments' \
--header 'Authorization: Basic Base64(appid:security_key)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "app_id",
    "timestamp": "{{datetime}}",
    "amount": "{{amount}}",
    "currency": "{{currency}}"
}'
```

--------------------------------

### createOrder Optional Parameters Example

Source: https://docs.pagsmile.com/reference/payin/submit-a-payin/brazil/creditcardpreauth/pagsmile-javascript.md

Example of createOrder with optional installments and address parameters. installments supports stage 1-12, address includes a 3-letter ISO country code.

```javascript
createOrder({ 
   installments: { stage: 3 }, //stage support 1 ~ 12
   address: { country_code: "SWE"} 
})
```

--------------------------------

### Request Sample

Source: https://docs.pagsmile.com/reference/payin/tools/supported-bank-list-query.md

A cURL example demonstrating how to perform a POST request to the bank-list endpoint.

```bash
curl --location --request POST 'https://gateway.pagsmile.com/trade/bank-list' \
--header 'Authorization: Basic Base64(appid:secret_key)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "app_id",
    "timestamp": "{{datetime}}",
    "method": "{{method}}"
}'
```

--------------------------------

### Request Sample (curl)

Source: https://docs.pagsmile.com/reference/payin/recurring-payment.md

Example curl command for creating a recurring payment. Uses the production gateway and includes all required parameters. Note the comments indicating method options (Wallet, CreditCard, PIX) and that trial_period and trial_amount are not available for PIX.

```bash
curl --location --request POST 'https://gateway.pagsmile.com/trade/recurring' \
--header 'Authorization: Basic Base64(appid:security_key)' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "1639****096",
    * "timestamp": "2024-05-20 13:42:06",
    * "version": "2.0",
    * "method": "Wallet", //Wallet, CreditCard, or PIX
    * "order_amount": "16.66",
    * "order_currency": "CNY",
    * "trial_amount":"6.66", //Not available for PIX
    * "trial_period":"5m", //Not available for PIX
    * "interval":"30m",
    * "quantity":3,
    * "out_trade_no": "out_29****00",
    * "subject": "trade pay test",
    * "content": "trade pay test conent",
    * "trade_type": "WEB",
    * "notify_url": "http://demo.gemini-tiger.cn/callback/success",
    * "return_url": "https://pagsmile.com/zh/",
    * "buyer_id": "299****600",
    * "timeout_express":"10900m"
}'
```

--------------------------------

### Get Payout Status cURL Example

Source: https://docs.pagsmile.com/reference/payout/payout-status.md

Example cURL request to the sandbox environment for retrieving payout status.

```bash
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout/status' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payout_id": "TPO2108090705014iNqtxektRS",
    "custom_code": "custom_code17902976588800"
}'
```

--------------------------------

### createOrder method usage

Source: https://docs.pagsmile.com/reference/payin/tools/pagsmile-javascript.md

Example of calling the createOrder method with optional parameters such as installments, address, and payer information.

```javascript
createOrder({ 
   installments: { stage: 3 },  
   address: { country_code: "SWE"},
   phone: "5575991435892",
   email: "test@gmail.com",
   postal_code: "12345678",
   payer_id: "12345678900", 
})
```

--------------------------------

### Get Account Balance cURL Request

Source: https://docs.pagsmile.com/reference/payout/account-balance.md

Example cURL command to request the account balance using the sandbox environment.

```bash
curl --location --request POST 'https://sandbox.transfersmile.com/api/balance' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
   * "timestamp": 1642075807
}'
```

--------------------------------

### Request example (curl)

Source: https://docs.pagsmile.com/reference/remittance-api/business/payment/query-beneficiary-detail.md

Full curl command to call the query-beneficiary-detail endpoint. Uses the sandbox base URL and includes the standard request envelope with placeholder values for partner_id, app_id, timestamp, version, language, random_key, request_id, sign_type, and biz_data.

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/payment/query-beneficiary-detail \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'
```

--------------------------------

### Request example using cURL

Source: https://docs.pagsmile.com/reference/remittance-api/business/collection/query-collections.md

A cURL command demonstrating how to send a request to the sandbox environment. Ensure you replace the placeholders with your actual partner_id, app_id, and encrypted data.

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/collection/query-collections \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'
```

--------------------------------

### curl example for payout list request

Source: https://docs.pagsmile.com/reference/payout/payout-list.md

Example curl command to call the payout list endpoint. Uses sandbox URL and test credentials. Note that page_num must start from 1 (0 is incorrect) and page_size should be greater than 0.

```bash
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout/list' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
   * "start_time": "2021-07-01 00:00:00",
   * "end_time": "2021-08-01 00:00:00",
   * "page_size": 100, // should be greater than 0
   * "page_num": 1, // should start from the number 1, while 0 is incorrect.
   * "timestamp": 1628512575
}'
```

--------------------------------

### Return Code (Success)

Source: https://docs.pagsmile.com/reference/payin/tools/installment-detail-query.md

Example success response with code 10000, message 'Success', and a fee list containing installment stages, amounts per stage, and total amounts.

```json
{
    "code": "10000",
    "msg": "Success",
    "fee": [
      {
        "stage":1,
        "amount_each":200.00,
        "amount":200.00
      },
      ...
    ]
}
```

--------------------------------

### curl example for POST /merchant/assets

Source: https://docs.pagsmile.com/reference/payin/account-balance.md

Example curl command to call the account balance endpoint. Uses test app id and authorization token for sandbox.

```bash
curl --location --request POST 'https://gateway-test.pagsmile.com/merchant/assets' \
--header 'Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
   * "app_id": "167**********8028",
   * "timestamp": "2023-08-03 07:48:01",
   * "version": "2.0",
     "currency": ""
}'
```

--------------------------------

### curl Example for Payout Proof

Source: https://docs.pagsmile.com/reference/payout/payout-proof.md

Example curl command to request payout proof. Uses sandbox test merchant ID and authorization token.

```bash
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout/voucher' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
   * "transaction_id": "TS202405201314******PB",
   * "timestamp": 1642075807
}'
```

--------------------------------

### Request Example for Query Deposit Result

Source: https://docs.pagsmile.com/reference/issuing-card-api/business/partner/query-deposit-result.md

Example request body for the Query Deposit Result API. The biz_data in this example needs to be encrypted.

```json
{
    "app_id": "00000000000000000",
    "partner_id": "00000000000000000",
    "request_id": "f37654bC-E056-f49E-689E-22c4447f",
    "timestamp": "2025-04-07 13:57:04",
    "format": "JSON",
    "version": "2.0",
    "sign_type": "RSA",
    "biz_data": {
        "order_no": "7DFEfCd2-3cEA-D757-cBA9-b7DceA4c"
    },
    "random_key": "<generated_key>"
}
// The biz_data in this example needs to be encrypted!
```

--------------------------------

### Request example using cURL

Source: https://docs.pagsmile.com/reference/remittance-api/business/payment/query-payment-orders.md

This cURL command demonstrates how to send a POST request to the sandbox environment with the required envelope fields.

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/payment/query-orders \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'
```

--------------------------------

### Update Cardholder Request Example

Source: https://docs.pagsmile.com/reference/issuing-card-api/business/cardholder/update-cardholder.md

A JSON request body example for updating a cardholder. Note that the biz_data field in this example must be encrypted.

```json
{
    "app_id": "00000000000000000",
    "partner_id": "00000000000000000",
    "request_id": "dcB88bc9-b6bc-26B8-b4c9-AF9cED1B",
    "timestamp": "2025-04-07 13:52:14",
    "format": "JSON",
    "version": "2.0",
    "sign_type": "RSA",
    "biz_data": {
        "holder_id": 103006,
        "mobile": "+8618197431263",
        "first_name": "Test",
        "last_name": "User",
        "id_no": "51f635df-d206-449c",
        "id_type": 1,
        "email": "n.hugidnsm@qwyswfg.ao",
        "birthday": "1990-11-08",
        "gender": 1,
        "issuance_date": "2024-07-21",
        "expires_on": "2030-07-24",
        "nationality_code": "BR",
        "address": {
            "city_name": "beijing",
            "country_code": "BR",
            "postal_code": "045675",
            "state": "proident enim",
            "line": "Wivjq Njutsfd Hiqouxlbs Uhdt Gtjpzy",
            "line2": "Ebtorcbaq Enojuvm Ikw Xvlgum Wibq U"
        }
    },
    "random_key": "<generated_key>"
}
// The biz_data in this example needs to be encrypted!
```

--------------------------------

### Request example using curl

Source: https://docs.pagsmile.com/reference/remittance-api/business/exchange/query-support-currency-pairs.md

Example curl command to call the query-currency-pairs endpoint. The partner_id and app_id are placeholders; replace them with your assigned values.

```bash
curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/exchange/query-currency-pairs \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'
```

--------------------------------

### 200:OK Response Example

Source: https://docs.pagsmile.com/reference/issuing-card-api/business/card/query-transactions.md

Example of a successful response with code 10000. The data array contains transaction details. The example data has already been decrypted.

```json
{
    "code": "10000",
    "msg": "Success",
    "total": 1,
    "random_key": "<random key used for decryption>",
    "sign_type": "RSA",
    "app_id": "00000000000000000",
    "data": [{
        "transaction_id": "100000076796",
        "order_no": "fE2E44c2-A4cF-C4Fc-40d6-Ee493262",
        "card_token": "450620141926",
        "transaction_type": 120,
        "transaction_status": 1,
        "account_num": "658704******3982",
        "account_name": "Steven Lopez",
        "bill_currency": "USD",
        "bill_amount": "1.23",
        "bill_fee": "0.00",
        "balance_change": "1.23",
        "balance": "100012059.48",
        "transaction_amount": "1.23",
        "transaction_currency": "USD",
        "exchange_rate": "1.0000",
        "reference": null,
        "transaction_desc": "remark",
        "merchant_info": null,
        "related_transaction_id": "100000076795",
        "business_date": "2025-04-07",
        "create_time": "2025-04-07 05:56:53"
    }]
}
// The data in this example has already been decrypted.
```

--------------------------------

### Tokenization Request Example

Source: https://docs.pagsmile.com/reference/payin/pci-direct-integration/tokenize.md

A cURL command demonstrating how to send a POST request to the tokenization endpoint.

```bash
curl --location --request POST 'https://security-test.pagsmile.com/card/tokenize' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "timestamp": "2022-01-01 03:54:01",
    * "method": "CreditCard", //CreditCard or DiscoverCard
    * "card": {
    *     "card_no": "",
          "issuer": "visa", 
          "holder": {
              "name": "Test User Name",
              "identification": {
                  "type": "CPF",
                  "number": "50284414727"
              }
          },
    *     "cvv": "",
    *     "valid_thru_year": "",
    *     "valid_thru_month": ""
      }
}'
```
Tokens:
Raw