# Overview

Before integrating a SmartFastPay product or solution, you must set up your development environment to get OAuth 2.0 Client ID and Secret credentials for the sandbox and live environments.

You exchange these credentials for an access token that authorizes your REST API calls. To test your web and mobile apps, you create sandbox accounts

Logging into the [Smart Platform](https://app.smartfastpay.com) to get credentials and create sandbox accounts requires a developer, support, or admin account. Each account provides different levels of access to API functionality.

<table><thead><tr><th width="251">Capabilities</th><th width="179" align="center">Developer Account</th><th width="167" align="center">Support Account</th><th align="center">Admin Account</th></tr></thead><tbody><tr><td>Access Smart Platform</td><td align="center"><strong>x</strong></td><td align="center"><strong>x</strong></td><td align="center"><strong>x</strong></td></tr><tr><td>Customize Payment Page</td><td align="center"><strong>x</strong></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Create New Users</td><td align="center"></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Create Credentials</td><td align="center"></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Manage Transactions (Just on Sandbox Env.)</td><td align="center"><strong>x</strong></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Generate Reports</td><td align="center"></td><td align="center"><strong>x</strong></td><td align="center"><strong>x</strong></td></tr></tbody></table>

***

### Get credentials

To generate REST API credentials for the sandbox and live environments:

1. Log in to the Smart Platform with your account.
2. Under the **MANAGEMENT** menu, select **Credentials**.
3. Remember to write down the chosen client\_secret, once saved, there is no way to recover it, you will need to create a new one.

***

### Get an access token

Your access token authorizes you to use the SmartFastPay REST API server. To call a REST API in your integration, exchange your client ID and secret for an access token in an OAuth 2.0 token call. While there are a few ways to get a token, here are examples using both the Postman app and a cURL command.

Your own environment's HTTP library or function may have <mark style="color:red;">`username`</mark> and <mark style="color:red;">`password`</mark> fields or an `auth` parameter in which you pass your client ID and secret. You can also add your Base64 encoded client ID and secret in an <mark style="color:red;">`Authorization: Basic`</mark> header.<br>

***

### Make REST API calls

In REST API calls, include the URL to the API service for the environment:

* Sandbox: <mark style="color:red;">`https://sandbox.smartfastpay.com`</mark>
* Live: <mark style="color:red;">`https://api.smartfastpay.com`</mark>

Also, include your access token to prove your identity and access protected resources.

This sample call, which shows the Transaction creates, includes a bearer token in the Authorization request header. This type of token lets you complete an action on behalf of a resource owner.

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "branch": "Office 2",
        "name": "Richard Roe",
        "amount": 4300,
        "currency": "USD",
        "callback": "http://mysite.com/api/notification",
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "redirect": {
                "url": "http://mysite.com/success_payment",
                "type": "URL"
            }
        }
    }'
```

The response shows the page or url, choosed by redirect type:

```json
{
    "requestId": "73eaaecf-1bf4-4847-b4a9-8c615e891e1b",
    "data": {
        "url": "https://sandbox.smartfastpay.com/checkout/v1/f834fc1b-c8a0-4613-bcc9-2c188f6ef180",
        "transaction_id": "f834fc1b-c8a0-4613-bcc9-2c188f6ef180"
    }
}
```


# API Requests

To make a REST API request, you combine the HTTP GET, POST, PUT, PATCH, or DELETE method, the URL to the API service, the URI to a resource to query, submit data to, update, or delete, and one or more

The URL to the API service is either:

* Sandbox: <mark style="color:red;">`https://sandbox.smartfastpay.com`</mark>
* Live: <mark style="color:red;">`https://api.smartfastpay.com`</mark>

Optionally, you can include query parameters on GET calls to filter, limit the size of, and sort the data in the responses.

Most <mark style="color:red;">`GET`</mark>, <mark style="color:red;">`POST`</mark>, <mark style="color:red;">`PUT`</mark>, and <mark style="color:red;">`PATCH`</mark> calls require a JSON request body.

This sample request oauth token

```bash
curl -v --location --request POST https://sandbox.smartfastpay.com/oauth2/token \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic <EncodedClientIdClientSecret>' \
  --header 'Content-Type: application/json'
```

This sample request lists transactions:

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/transactions' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer <Access-Token>"
```

***

### Query parameters

For most REST <mark style="color:red;">`GET`</mark> calls, you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response. For filter parameters, see the individual <mark style="color:red;">`GET`</mark> calls.

To limit, or page, and sort the data that is returned in some API responses, use these, or similar, query parameters:<br>

> **Note:** Not all pagination parameters are available for all APIs.

<table><thead><tr><th width="193">Parameter</th><th width="209">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>limit</code></td><td><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 40</code></mark></td><td>The number of items to return in the response.</td></tr><tr><td><code>page</code></td><td><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 9999999</code></mark></td><td>The page number indicates which set of items will be returned in the response. So, the combination of <mark style="color:red;"><code>page=1</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns the first 20 items. The combination of <mark style="color:red;"><code>page=2</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns items 21 through 40.</td></tr><tr><td><code>sort</code></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: item,(asc|desc)</code></mark></td><td>Sorts the items in the response by filter in ascending or descending order.<br>Eg.: <mark style="color:red;"><code>sort=id,desc</code></mark><br><em>(This combination returns a list in descending order based on id.)</em></td></tr><tr><td><code>start_time</code></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The start date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>start_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><code>end_time</code></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The end date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>end_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><code>customer_id</code></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td>Sorts the items in the response by looking for the customer_id that was once provided by your system.</td></tr><tr><td><code>transaction_id</code></td><td><mark style="color:red;"><code>string</code></mark></td><td>Sorts the items in the response by looking for the transaction_id that was once provided by your system.<br>To get multiple transaction_id, send each transaction_id separating by comma (,).<br>Eg.: <mark style="color:red;"><code>8fecdfcc-4e4d-11ee,8fece5ee-4e4d-11ee,d42953be-4e4d-11ee</code></mark></td></tr></tbody></table>

For example, the Transaction API returns details for ten transactions starting with the second page sorted by descending id in the response:

{% code overflow="wrap" fullWidth="false" %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/transactions?limit=10&page=2&sort=id,desc' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer < Access-Token >"
```

{% endcode %}

***

### HTTP request headers

The commonly used HTTP request headers are:

{% hint style="info" %}
**Content-Type**
{% endhint %}

The response format, which is required for operations with a response body. The syntax is:

```graphql
Content-Type: application/format
```

Where <mark style="color:red;">`format`</mark> is <mark style="color:red;">`json`</mark>.

{% hint style="info" %}
**Authorization**
{% endhint %}

Required to get an access token or make API calls:

* **Get an access token**

  When you create a sandbox or live REST API app, SmartFastPay generates a set of OAuth 2.0 client ID and secret credentials for the sandbox or live environment. When you make a [get an access token](/resources/faq-and-support/authentication) call, set the <mark style="color:red;">`Authorization`</mark> header to these credentials for the environment in which you're making the call.

  In exchange for these credentials, the SmartFastPay authorization server issues a *bearer* access token that you use for authorization when you make REST API requests.

  A bearer token enables you to complete actions on behalf and with the approval of the resource owner.
* **Make REST API calls**

  Include the access token in the <mark style="color:red;">`Authorization`</mark> header with the <mark style="color:red;">`Bearer`</mark> authentication scheme:

  ```graphql
  Authorization: Bearer <Access-Token>
  ```


# Payments

Call the Payments API to request payments via Bank Transfer or PIX.

***

### <mark style="color:green;">GET</mark> /payment/{id}

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payment/{id}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
        "amount": "300.00",
        "currency": "USD",
        "status": "pending",
        "payment_status": "pending",
        "status_details": "Error detail if canceled",
        "method": "bank_transfer",
        "created_at": "2021-11-11T19:08:20.000000Z",
        "updated_at": "2021-11-11T19:08:20.000000Z"
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="202">Parameter</th><th width="545.8515625">Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>chargeback</code></mark></td></tr><tr><td><mark style="color:red;"><code>status_details</code></mark></td><td>This field describes the reason for the transaction cancellation.</td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td>The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.</td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>

***

### <mark style="color:green;">GET</mark> /payments

{% hint style="info" %}
**Request**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payments' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

```bash
# With parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payments?limit=1&order=id,desc' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Parameters detail**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payments' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

<table><thead><tr><th width="192">Parameter</th><th width="269" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>limit</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 40</code></mark></td><td>The number of items to return in the response.</td></tr><tr><td><mark style="color:red;"><code>page</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 9999999</code></mark></td><td>The page number indicating which set of items will be returned in the response. So, the combination of <mark style="color:red;"><code>page=1</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns the first 20 items. The combination of <mark style="color:red;"><code>page=2</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns items 21 through 40.</td></tr><tr><td><mark style="color:red;"><code>sort</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: item,(asc|desc)</code></mark></td><td>Sorts the items in the response by filter in ascending or descending order.<br>Eg.: <mark style="color:red;"><code>sort=id,desc</code></mark><br><em>(This combination returns a list in descending order based on id.)</em></td></tr><tr><td><mark style="color:red;"><code>start_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The start date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>start_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>end_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The end date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>end_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td>Sorts the items in the response by looking for the customer_id that was once provided by your system.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Sorts the items in the response by looking for the transaction_id that was once provided by your system.<br>To get multiple transaction_id, send each transaction_id separating by comma (,).<br>Eg.: <mark style="color:red;"><code>8fecdfcc-4e4d-11ee</code></mark><code>,</code><mark style="color:red;"><code>8fece5ee-4e4d-11ee</code></mark><code>, </code><mark style="color:red;"><code>d42953be-4e4d-11ee</code></mark></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": [
        {
            "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
            "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "amount": "300.00",
            "currency": "USD",
            "status": "pending",
            "payment_status": "pending",
            "payment_method": "pix",
            "status_details": "Error detail if canceled",
            "method": "bank_transfer",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        },
        {
            "id": "3eff3ce4-9666-4b93-8bbc-64887f164622",
            "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
            "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
            "amount": "980.00",
            "currency": "USD",
            "status": "pending",
            "payment_status": "pending",
            "payment_method": "pix",
            "status_details": "Error detail if canceled",
            "method": "pix",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        }
    ],
    "current_page": 1,
    "last_page": 1,
    "per_page": 10,
    "to": 2,
    "total": 2
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="192">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>chargeback</code></mark></td></tr><tr><td><mark style="color:red;"><code>status_details</code></mark></td><td>This field describes the reason for the transaction cancellation.</td></tr><tr><td><mark style="color:red;"><code>payment_method</code></mark></td><td>The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.</td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>


# Payouts

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:green;">GET</mark> /payout/{id}

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payout/{id}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "f569c39c-71c2-44a2-8f95-d5840886bbe3",
        "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
        "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
        "amount": "98000.00",
        "currency": "COL",
        "status": "pending",
        "status_details": "Error detail if canceled",
        "created_at": "2021-11-11T19:08:20.000000Z",
        "updated_at": "2021-11-11T19:08:20.000000Z"
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="202">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction.</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>success</code></mark>, <mark style="color:red;"><code>failed</code></mark>, <mark style="color:red;"><code>onhold</code></mark>, <mark style="color:red;"><code>returned</code></mark>, <mark style="color:red;"><code>refunded</code></mark></td></tr><tr><td><mark style="color:red;"><code>status_details</code></mark></td><td>This field describes the reason for the transaction cancellation.</td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>

***

### <mark style="color:green;">GET</mark> /payouts

{% hint style="info" %}
**Request**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payouts' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

```bash
# With parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/payouts?limit=1&order=id,desc' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="192">Parameter</th><th width="269" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>limit</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 40</code></mark></td><td>The number of items to return in the response.</td></tr><tr><td><mark style="color:red;"><code>page</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 9999999</code></mark></td><td>The page number indicating which set of items will be returned in the response. So, the combination of <mark style="color:red;"><code>page=1</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns the first 20 items. The combination of <mark style="color:red;"><code>page=2</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns items 21 through 40.</td></tr><tr><td><mark style="color:red;"><code>sort</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: item,(asc|desc)</code></mark></td><td>Sorts the items in the response by filter in ascending or descending order.<br>Eg.: <mark style="color:red;"><code>sort=id,desc</code></mark><br><em>(This combination returns a list in descending order based on id.)</em></td></tr><tr><td><mark style="color:red;"><code>start_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The start date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>start_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>end_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The end date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>end_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td>Sorts the items in the response by looking for the customer_id that was once provided by your system.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Sorts the items in the response by looking for the transaction_id that was once provided by your system.<br>To get multiple transaction_id, send each transaction_id separating by comma (,).<br>Eg.: <mark style="color:red;"><code>8fecdfcc-4e4d-11ee</code></mark><code>,</code><mark style="color:red;"><code>8fece5ee-4e4d-11ee</code></mark><code>, </code><mark style="color:red;"><code>d42953be-4e4d-11ee</code></mark></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": [
        {
            "id": "897c9e20-1262-4679-a850-403d37b2a727",
            "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
            "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
            "amount": "98000.00",
            "currency": "COL",
            "status": "pending",
            "status_details": "Error detail if canceled",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        },
        {
            "id": "f569c39c-71c2-44a2-8f95-d5840886bbe3",
            "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "amount": "30000.00",
            "currency": "COL",
            "status": "pending",
            "status_details": "Error detail if canceled",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        }
    ]
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="192">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction.</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>success</code></mark>, <mark style="color:red;"><code>failed</code></mark>, <mark style="color:red;"><code>onhold</code></mark>, <mark style="color:red;"><code>returned</code></mark>, <mark style="color:red;"><code>refunded</code></mark></td></tr><tr><td><mark style="color:red;"><code>status_details</code></mark></td><td>This field describes the reason for the transaction cancellation.</td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>


# Checkout Experience


# Old Overview

Use the Checkout API for a secure checkout via SmartFastPay. It auto-presents relevant payment types to shoppers, easing purchase with methods like Bank Transfer, PIX, PSE, Deuna and more.

***

### <mark style="color:orange;">POST</mark> /transaction/checkout

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "amount": 4300,
        "currency": "USD",
        "callback": "http://mysite.com/api/notification",
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "redirect": {
                "url": "http://mysite.com/success_payment",
                "type": "URL"
            }
        },
        "payment": {
            "method": ["pix","boleto","picpay","bank_transfer", "pse" ...]
        }
    }'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="193">Parameter</th><th width="196" align="center">Type</th><th width="100" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>branch</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>When the merchant needs to keep track of its various offices / branch, this field must be fill.</td></tr><tr><td><mark style="color:red;"><code>name</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 3 | max: 150</code></mark></td><td align="center"><strong>yes</strong></td><td>Name of the customer who started the transaction.</td></tr><tr><td><mark style="color:red;"><code>email</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>Email of the customer who started the transaction.</td></tr><tr><td><mark style="color:red;"><code>document</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>Brazilian document (CPF) of the customer who started the transaction.<br>- Must be a valid CPF document;<br><mark style="color:red;"><code>Eg: 12345678909</code></mark></td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td align="center"><mark style="color:red;"><code>decimal (10,2)</code></mark><br><mark style="color:red;"><code>min: 2</code></mark></td><td align="center"><strong>yes</strong></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency type that the amount will be credited.</td></tr><tr><td><mark style="color:red;"><code>country</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td align="center"><strong>yes</strong></td><td>The country type that the amount will be credited.</td></tr><tr><td><mark style="color:red;"><code>callback</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 250</code></mark><br><mark style="color:red;"><code>(Method: POST)</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL in you site that our API will notify when the payment changes the status, the HTTP supported method should be HTTP<br><mark style="color:red;"><code>Eg: http://my-url-callback/</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td align="center"><mark style="color:red;"><code>array</code></mark><br><mark style="color:red;"><code>min: 1</code></mark></td><td align="center">no</td><td>By using this field, our checkout page will only list the payment methods entered here. <code>Allowed:</code> <code>pix, picpay, boleto, pse, transfiya, cobre,  bank_transfer and others...</code></td></tr><tr><td><mark style="color:red;"><code>transaction</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>redirect</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>url</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 250</code></mark></td><td align="center"><strong>yes</strong></td><td>Redirect URL that we will set to our "back to website" button after the transaction was completed</td></tr><tr><td><mark style="color:red;"><code>type</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(HTML or URL)</code></mark><br><mark style="color:red;"><code>min: 0 | max: 10</code></mark></td><td align="center"><strong>yes</strong></td><td>Return type of the request, if HTML is provided the request will return the HTML of the page, if URL is provided the request will return a URL with that will redirect to the HTML page rendered.</td></tr></tbody></table>

{% hint style="info" %}
**Response (URL)**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "url": "https://sandbox-checkout.smartfastpay.com/v1/cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e"
        "transaction_id": "cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e",
        "expires_in": 1694786912
    }
}
```

{% hint style="info" %}
**Response (HTML)**
{% endhint %}

<div><figure><img src="/files/IoxWjkmDNM6oDScx8R52" alt=""><figcaption></figcaption></figure> <figure><img src="/files/aQM4I3KfpvnuoIXXiIDR" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="/files/HWeUl7CMlxicyoZa3T2B" alt=""><figcaption></figcaption></figure> <figure><img src="/files/qq2mETcVuplYEKFl0Tgi" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="/files/Xlw4jxeIuRTb4uXNXutV" alt=""><figcaption></figcaption></figure> <figure><img src="/files/U5gBBRPanE6y7TTJNUON" alt=""><figcaption></figcaption></figure> <figure><img src="/files/KgUj24n77Opfvkpy19Y9" alt=""><figcaption></figcaption></figure></div>


# Overview

Use the Checkout API to generate a secure payment page via SmartFastPay.

The parameters provided here are mandatory for creating the payment link, ensuring that relevant payment methods like Bank Transfer, PIX, PSE, Deuna, and more are automatically presented to shoppers.\
\
In addition to the required parameters, we offer optional fields that can be included to enhance the user experience. These fields allow pre-filled information, such as address, documents, and other personal data, to be automatically transferred, preventing users from having to re-enter them when they reach our payment page.

To access the complete and detailed list of all available parameters, including optional ones, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/transaction/checkout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "12345678909",
                "type": "CPF"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "BRL",
            "amount": 100.00,
        },
        "branch": "YourCompanyOrBranchName",
        "country": "BRA",
        "notification_url": "https://mysite.com/api/notification",
        "redirect_url": "https://mysite.com/success"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong><br><em>optional on (v2/transaction/checkout)</em></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong><br><em>optional on (v2/transaction/checkout)</em></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong><br><em>optional on (v2/transaction/checkout)</em></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong><br><em>optional on (v2/transaction/checkout)</em></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>array</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td>redirect_url</td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "url": "https://sandbox-checkout.smartfastpay.com/v1/cbfc1b2e-b1d7-42c0-8dc5-ffe94d64938e/cGADUcGFK9DJJvbGV0dyxwaXgsYmFua190cmAODHcg==/eyJkf3j982b2N1bWVuJAH8FHXIiOiIxMjM0NTY3ODkka90F8HJR5cGUiOiJDUEYifSwadhugcmEiOltdfQ=="
        "transaction_id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "expires_in": 1722108649
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}


# API Requests


# Transactions

Call the Payments API to request transactions via bank transfer or pix.

***

### <mark style="color:green;">GET</mark> /transaction/{id}

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/transaction/{id}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "744252be-fe0b-4209-838c-93635b157951",
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
        "amount": "300.00",
        "currency": "USD",
        "status": "pending",
        "type": "payment",
        "method": "bank_transfer",
        "payment_status": "pending",
        "created_at": "2021-11-11T19:08:20.000000Z",
        "updated_at": "2021-11-11T19:08:20.000000Z"
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="202">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>open</code></mark>, <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>canceled</code></mark></td></tr><tr><td><mark style="color:red;"><code>type</code></mark></td><td>Shows the type of this transaction. <mark style="color:red;"><code>payment</code></mark> or <mark style="color:red;"><code>payout</code></mark></td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td>Shows the payment method of this transaction, usually <mark style="color:red;"><code>bank_transfer</code></mark> or <mark style="color:red;"><code>pix</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>payout_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>success</code></mark>, <mark style="color:red;"><code>failed</code></mark>, <mark style="color:red;"><code>onhold</code></mark>, <mark style="color:red;"><code>returned</code></mark>, <mark style="color:red;"><code>refunded</code></mark></td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>

***

### <mark style="color:green;">GET</mark> /transactions

{% hint style="info" %}
**Request**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/transactions' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer < Access-Token >' \'
```

```bash
# With parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/transactions?limit=1&order=id,desc' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer < Access-Token >' \'
```

{% hint style="info" %}
**Parameters detail**
{% endhint %}

<table><thead><tr><th width="192">Parameter</th><th width="269" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>limit</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 40</code></mark></td><td>The number of items to return in the response.</td></tr><tr><td><mark style="color:red;"><code>page</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 9999999</code></mark></td><td>The page number indicating which set of items will be returned in the response. So, the combination of <mark style="color:red;"><code>page=1</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns the first 20 items. The combination of <mark style="color:red;"><code>page=2</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns items 21 through 40.</td></tr><tr><td><mark style="color:red;"><code>sort</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: item,(asc|desc)</code></mark></td><td>Sorts the items in the response by filter in ascending or descending order.<br>Eg.: <mark style="color:red;"><code>sort=id,desc</code></mark><br><em>(This combination returns a list in descending order based on id.)</em></td></tr><tr><td><mark style="color:red;"><code>start_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The start date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>start_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>end_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The end date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>end_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td>Sorts the items in the response by looking for the customer_id that was once provided by your system.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Sorts the items in the response by looking for the transaction_id that was once provided by your system.<br>To get multiple transaction_id, send each transaction_id separating by comma (,).<br>Eg.: <mark style="color:red;"><code>8fecdfcc-4e4d-11ee</code></mark><code>,</code><mark style="color:red;"><code>8fece5ee-4e4d-11ee</code></mark><code>, </code><mark style="color:red;"><code>d42953be-4e4d-11ee</code></mark></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": [
        {
            "id": "b2a9a131-ba69-4722-a2de-67062268bc27",
            "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
            "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
            "amount": "980.00",
            "currency": "USD",
            "status": "pending",
            "type": "payout",
            "payout_status": "pending",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        },
        {
            "id": "744252be-fe0b-4209-838c-93635b157951",
            "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "amount": "300.00",
            "currency": "USD",
            "status": "pending",
            "type": "payment",
            "method": "bank_transfer",
            "payment_status": "pending",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        },
        {
            "id": "af78bccd-cc66-4e92-8ee6-56b3d6686327",
            "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
            "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
            "amount": "980.00",
            "currency": "USD",
            "status": "pending",
            "type": "payment",
            "method": "pix",
            "payment_status": "pending",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        }
    ]
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="202">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>open</code></mark>, <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>canceled</code></mark></td></tr><tr><td><mark style="color:red;"><code>type</code></mark></td><td>Shows the type of this transaction. <mark style="color:red;"><code>payment</code></mark> or <mark style="color:red;"><code>payout</code></mark></td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td>Shows the payment method of this transaction, usually <mark style="color:red;"><code>bank_transfer</code></mark> or <mark style="color:red;"><code>pix</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>payout_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>success</code></mark>, <mark style="color:red;"><code>failed</code></mark>, <mark style="color:red;"><code>onhold</code></mark>, <mark style="color:red;"><code>returned</code></mark>, <mark style="color:red;"><code>refunded</code></mark></td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>


# Country Codes

This is a complete list of all country ISO codes as described in the ISO 3166 international standard.\
These codes are used throughout the IT industry by computer systems and software to ease the identification of country names.

<table><thead><tr><th width="475">Country</th><th width="402">Code</th></tr></thead><tbody><tr><td>Afghanistan</td><td>AFG</td></tr><tr><td>Albania</td><td>ALB</td></tr><tr><td>Algeria</td><td>DZA</td></tr><tr><td>American Samoa</td><td>ASM</td></tr><tr><td>Andorra</td><td>AND</td></tr><tr><td>Angola</td><td>AGO</td></tr><tr><td>Anguilla</td><td>AIA</td></tr><tr><td>Antarctica</td><td>ATA</td></tr><tr><td>Antigua and Barbuda</td><td>ATG</td></tr><tr><td>Argentina</td><td>ARG</td></tr><tr><td>Armenia</td><td>ARM</td></tr><tr><td>Aruba</td><td>ABW</td></tr><tr><td>Australia</td><td>AUS</td></tr><tr><td>Austria</td><td>AUT</td></tr><tr><td>Azerbaijan</td><td>AZE</td></tr><tr><td>Bahamas (the)</td><td>BHS</td></tr><tr><td>Bahrain</td><td>BHR</td></tr><tr><td>Bangladesh</td><td>BGD</td></tr><tr><td>Barbados</td><td>BRB</td></tr><tr><td>Belarus</td><td>BLR</td></tr><tr><td>Belgium</td><td>BEL</td></tr><tr><td>Belize</td><td>BLZ</td></tr><tr><td>Benin</td><td>BEN</td></tr><tr><td>Bermuda</td><td>BMU</td></tr><tr><td>Bhutan</td><td>BTN</td></tr><tr><td>Bolivia (Plurinational State of)</td><td>BOL</td></tr><tr><td>Bonaire, Sint Eustatius and Saba</td><td>BES</td></tr><tr><td>Bosnia and Herzegovina</td><td>BIH</td></tr><tr><td>Botswana</td><td>BWA</td></tr><tr><td>Bouvet Island</td><td>BVT</td></tr><tr><td>Brazil</td><td>BRA</td></tr><tr><td>British Indian Ocean Territory (the)</td><td>IOT</td></tr><tr><td>Brunei Darussalam</td><td>BRN</td></tr><tr><td>Bulgaria</td><td>BGR</td></tr><tr><td>Burkina Faso</td><td>BFA</td></tr><tr><td>Burundi</td><td>BDI</td></tr><tr><td>Cabo Verde</td><td>CPV</td></tr><tr><td>Cambodia</td><td>KHM</td></tr><tr><td>Cameroon</td><td>CMR</td></tr><tr><td>Canada</td><td>CAN</td></tr><tr><td>Cayman Islands (the)</td><td>CYM</td></tr><tr><td>Central African Republic (the)</td><td>CAF</td></tr><tr><td>Chad</td><td>TCD</td></tr><tr><td>Chile</td><td>CHL</td></tr><tr><td>China</td><td>CHN</td></tr><tr><td>Christmas Island</td><td>CXR</td></tr><tr><td>Cocos (Keeling) Islands (the)</td><td>CCK</td></tr><tr><td>Colombia</td><td>COL</td></tr><tr><td>Comoros (the)</td><td>COM</td></tr><tr><td>Congo (the Democratic Republic of the)</td><td>COD</td></tr><tr><td>Congo (the)</td><td>COG</td></tr><tr><td>Cook Islands (the)</td><td>COK</td></tr><tr><td>Costa Rica</td><td>CRI</td></tr><tr><td>Croatia</td><td>HRV</td></tr><tr><td>Cuba</td><td>CUB</td></tr><tr><td>Curaçao</td><td>CUW</td></tr><tr><td>Cyprus</td><td>CYP</td></tr><tr><td>Czechia</td><td>CZE</td></tr><tr><td>Côte d'Ivoire</td><td>CIV</td></tr><tr><td>Denmark</td><td>DNK</td></tr><tr><td>Djibouti</td><td>DJI</td></tr><tr><td>Dominica</td><td>DMA</td></tr><tr><td>Dominican Republic (the)</td><td>DOM</td></tr><tr><td>Ecuador</td><td>ECU</td></tr><tr><td>Egypt</td><td>EGY</td></tr><tr><td>El Salvador</td><td>SLV</td></tr><tr><td>Equatorial Guinea</td><td>GNQ</td></tr><tr><td>Eritrea</td><td>ERI</td></tr><tr><td>Estonia</td><td>EST</td></tr><tr><td>Eswatini</td><td>SWZ</td></tr><tr><td>Ethiopia</td><td>ETH</td></tr><tr><td>Falkland Islands (the) [Malvinas]</td><td>FLK</td></tr><tr><td>Faroe Islands (the)</td><td>FRO</td></tr><tr><td>Fiji</td><td>FJI</td></tr><tr><td>Finland</td><td>FIN</td></tr><tr><td>France</td><td>FRA</td></tr><tr><td>French Guiana</td><td>GUF</td></tr><tr><td>French Polynesia</td><td>PYF</td></tr><tr><td>French Southern Territories (the)</td><td>ATF</td></tr><tr><td>Gabon</td><td>GAB</td></tr><tr><td>Gambia (the)</td><td>GMB</td></tr><tr><td>Georgia</td><td>GEO</td></tr><tr><td>Germany</td><td>DEU</td></tr><tr><td>Ghana</td><td>GHA</td></tr><tr><td>Gibraltar</td><td>GIB</td></tr><tr><td>Greece</td><td>GRC</td></tr><tr><td>Greenland</td><td>GRL</td></tr><tr><td>Grenada</td><td>GRD</td></tr><tr><td>Guadeloupe</td><td>GLP</td></tr><tr><td>Guam</td><td>GUM</td></tr><tr><td>Guatemala</td><td>GTM</td></tr><tr><td>Guernsey</td><td>GGY</td></tr><tr><td>Guinea</td><td>GIN</td></tr><tr><td>Guinea-Bissau</td><td>GNB</td></tr><tr><td>Guyana</td><td>GUY</td></tr><tr><td>Haiti</td><td>HTI</td></tr><tr><td>Heard Island and McDonald Islands</td><td>HMD</td></tr><tr><td>Holy See (the)</td><td>VAT</td></tr><tr><td>Honduras</td><td>HND</td></tr><tr><td>Hong Kong</td><td>HKG</td></tr><tr><td>Hungary</td><td>HUN</td></tr><tr><td>Iceland</td><td>ISL</td></tr><tr><td>India</td><td>IND</td></tr><tr><td>Indonesia</td><td>IDN</td></tr><tr><td>Iran (Islamic Republic of)</td><td>IRN</td></tr><tr><td>Iraq</td><td>IRQ</td></tr><tr><td>Ireland</td><td>IRL</td></tr><tr><td>Isle of Man</td><td>IMN</td></tr><tr><td>Israel</td><td>ISR</td></tr><tr><td>Italy</td><td>ITA</td></tr><tr><td>Jamaica</td><td>JAM</td></tr><tr><td>Japan</td><td>JPN</td></tr><tr><td>Jersey</td><td>JEY</td></tr><tr><td>Jordan</td><td>JOR</td></tr><tr><td>Kazakhstan</td><td>KAZ</td></tr><tr><td>Kenya</td><td>KEN</td></tr><tr><td>Kiribati</td><td>KIR</td></tr><tr><td>Korea (the Democratic People's Republic of)</td><td>PRK</td></tr><tr><td>Korea (the Republic of)</td><td>KOR</td></tr><tr><td>Kuwait</td><td>KWT</td></tr><tr><td>Kyrgyzstan</td><td>KGZ</td></tr><tr><td>Lao People's Democratic Republic (the)</td><td>LAO</td></tr><tr><td>Latvia</td><td>LVA</td></tr><tr><td>Lebanon</td><td>LBN</td></tr><tr><td>Lesotho</td><td>LSO</td></tr><tr><td>Liberia</td><td>LBR</td></tr><tr><td>Libya</td><td>LBY</td></tr><tr><td>Liechtenstein</td><td>LIE</td></tr><tr><td>Lithuania</td><td>LTU</td></tr><tr><td>Luxembourg</td><td>LUX</td></tr><tr><td>Macao</td><td>MAC</td></tr><tr><td>Madagascar</td><td>MDG</td></tr><tr><td>Malawi</td><td>MWI</td></tr><tr><td>Malaysia</td><td>MYS</td></tr><tr><td>Maldives</td><td>MDV</td></tr><tr><td>Mali</td><td>MLI</td></tr><tr><td>Malta</td><td>MLT</td></tr><tr><td>Marshall Islands (the)</td><td>MHL</td></tr><tr><td>Martinique</td><td>MTQ</td></tr><tr><td>Mauritania</td><td>MRT</td></tr><tr><td>Mauritius</td><td>MUS</td></tr><tr><td>Mayotte</td><td>MYT</td></tr><tr><td>Mexico</td><td>MEX</td></tr><tr><td>Micronesia (Federated States of)</td><td>FSM</td></tr><tr><td>Moldova (the Republic of)</td><td>MDA</td></tr><tr><td>Monaco</td><td>MCO</td></tr><tr><td>Mongolia</td><td>MNG</td></tr><tr><td>Montenegro</td><td>MNE</td></tr><tr><td>Montserrat</td><td>MSR</td></tr><tr><td>Morocco</td><td>MAR</td></tr><tr><td>Mozambique</td><td>MOZ</td></tr><tr><td>Myanmar</td><td>MMR</td></tr><tr><td>Namibia</td><td>NAM</td></tr><tr><td>Nauru</td><td>NRU</td></tr><tr><td>Nepal</td><td>NPL</td></tr><tr><td>Netherlands (the)</td><td>NLD</td></tr><tr><td>New Caledonia</td><td>NCL</td></tr><tr><td>New Zealand</td><td>NZL</td></tr><tr><td>Nicaragua</td><td>NIC</td></tr><tr><td>Niger (the)</td><td>NER</td></tr><tr><td>Nigeria</td><td>NGA</td></tr><tr><td>Niue</td><td>NIU</td></tr><tr><td>Norfolk Island</td><td>NFK</td></tr><tr><td>Northern Mariana Islands (the)</td><td>MNP</td></tr><tr><td>Norway</td><td>NOR</td></tr><tr><td>Oman</td><td>OMN</td></tr><tr><td>Pakistan</td><td>PAK</td></tr><tr><td>Palau</td><td>PLW</td></tr><tr><td>Palestine, State of</td><td>PSE</td></tr><tr><td>Panama</td><td>PAN</td></tr><tr><td>Papua New Guinea</td><td>PNG</td></tr><tr><td>Paraguay</td><td>PRY</td></tr><tr><td>Peru</td><td>PER</td></tr><tr><td>Philippines (the)</td><td>PHL</td></tr><tr><td>Pitcairn</td><td>PCN</td></tr><tr><td>Poland</td><td>POL</td></tr><tr><td>Portugal</td><td>PRT</td></tr><tr><td>Puerto Rico</td><td>PRI</td></tr><tr><td>Qatar</td><td>QAT</td></tr><tr><td>Republic of North Macedonia</td><td>MKD</td></tr><tr><td>Romania</td><td>ROU</td></tr><tr><td>Russian Federation (the)</td><td>RUS</td></tr><tr><td>Rwanda</td><td>RWA</td></tr><tr><td>Réunion</td><td>REU</td></tr><tr><td>Saint Barthélemy</td><td>BLM</td></tr><tr><td>Saint Helena, Ascension and Tristan da Cunha</td><td>SHN</td></tr><tr><td>Saint Kitts and Nevis</td><td>KNA</td></tr><tr><td>Saint Lucia</td><td>LCA</td></tr><tr><td>Saint Martin (French part)</td><td>MAF</td></tr><tr><td>Saint Pierre and Miquelon</td><td>SPM</td></tr><tr><td>Saint Vincent and the Grenadines</td><td>VCT</td></tr><tr><td>Samoa</td><td>WSM</td></tr><tr><td>San Marino</td><td>SMR</td></tr><tr><td>Sao Tome and Principe</td><td>STP</td></tr><tr><td>Saudi Arabia</td><td>SAU</td></tr><tr><td>Senegal</td><td>SEN</td></tr><tr><td>Serbia</td><td>SRB</td></tr><tr><td>Seychelles</td><td>SYC</td></tr><tr><td>Sierra Leone</td><td>SLE</td></tr><tr><td>Singapore</td><td>SGP</td></tr><tr><td>Sint Maarten (Dutch part)</td><td>SXM</td></tr><tr><td>Slovakia</td><td>SVK</td></tr><tr><td>Slovenia</td><td>SVN</td></tr><tr><td>Solomon Islands</td><td>SLB</td></tr><tr><td>Somalia</td><td>SOM</td></tr><tr><td>South Africa</td><td>ZAF</td></tr><tr><td>South Georgia and the South Sandwich Islands</td><td>SGS</td></tr><tr><td>South Sudan</td><td>SSD</td></tr><tr><td>Spain</td><td>ESP</td></tr><tr><td>Sri Lanka</td><td>LKA</td></tr><tr><td>Sudan (the)</td><td>SDN</td></tr><tr><td>Suriname</td><td>SUR</td></tr><tr><td>Svalbard and Jan Mayen</td><td>SJM</td></tr><tr><td>Sweden</td><td>SWE</td></tr><tr><td>Switzerland</td><td>CHE</td></tr><tr><td>Syrian Arab Republic</td><td>SYR</td></tr><tr><td>Taiwan (Province of China)</td><td>TWN</td></tr><tr><td>Tajikistan</td><td>TJK</td></tr><tr><td>Tanzania, United Republic of</td><td>TZA</td></tr><tr><td>Thailand</td><td>THA</td></tr><tr><td>Timor-Leste</td><td>TLS</td></tr><tr><td>Togo</td><td>TGO</td></tr><tr><td>Tokelau</td><td>TKL</td></tr><tr><td>Tonga</td><td>TON</td></tr><tr><td>Trinidad and Tobago</td><td>TTO</td></tr><tr><td>Tunisia</td><td>TUN</td></tr><tr><td>Turkey</td><td>TUR</td></tr><tr><td>Turkmenistan</td><td>TKM</td></tr><tr><td>Turks and Caicos Islands (the)</td><td>TCA</td></tr><tr><td>Tuvalu</td><td>TUV</td></tr><tr><td>Uganda</td><td>UGA</td></tr><tr><td>Ukraine</td><td>UKR</td></tr><tr><td>United Arab Emirates (the)</td><td>ARE</td></tr><tr><td>United Kingdom of Great Britain and Northern Ireland (the)</td><td>GBR</td></tr><tr><td>United States Minor Outlying Islands (the)</td><td>UMI</td></tr><tr><td>United States of America (the)</td><td>USA</td></tr><tr><td>Uruguay</td><td>URY</td></tr><tr><td>Uzbekistan</td><td>UZB</td></tr><tr><td>Vanuatu</td><td>VUT</td></tr><tr><td>Venezuela (Bolivarian Republic of)</td><td>VEN</td></tr><tr><td>Viet Nam</td><td>VNM</td></tr><tr><td>Virgin Islands (British)</td><td>VGB</td></tr><tr><td>Virgin Islands (U.S.)</td><td>VIR</td></tr><tr><td>Wallis and Futuna</td><td>WLF</td></tr><tr><td>Western Sahara</td><td>ESH</td></tr><tr><td>Yemen</td><td>YEM</td></tr><tr><td>Zambia</td><td>ZMB</td></tr><tr><td>Zimbabwe</td><td>ZWE</td></tr><tr><td>Åland Islands</td><td>ALA</td></tr></tbody></table>


# Currency Codes

This is a complete list of all country currency ISO codes as described in the ISO 3166 international standard.\
These codes are used throughout the IT industry by computer systems and software to ease the identification of currency names.<br>

<table><thead><tr><th width="392">Country</th><th width="256">Currency</th><th>Code</th></tr></thead><tbody><tr><td>AFGHANISTAN</td><td>Afghani</td><td>AFN</td></tr><tr><td>ALBANIA</td><td>Lek</td><td>ALL</td></tr><tr><td>ALGERIA</td><td>Algerian Dinar</td><td>DZD</td></tr><tr><td>AMERICAN SAMOA</td><td>US Dollar</td><td>USD</td></tr><tr><td>ANDORRA</td><td>Euro</td><td>EUR</td></tr><tr><td>ANGOLA</td><td>Kwanza</td><td>AOA</td></tr><tr><td>ANGUILLA</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>ANTARCTICA</td><td>No universal currency</td><td></td></tr><tr><td>ANTIGUA AND BARBUDA</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>ARGENTINA</td><td>Argentine Peso</td><td>ARS</td></tr><tr><td>ARMENIA</td><td>Armenian Dram</td><td>AMD</td></tr><tr><td>ARUBA</td><td>Aruban Florin</td><td>AWG</td></tr><tr><td>AUSTRALIA</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>AUSTRIA</td><td>Euro</td><td>EUR</td></tr><tr><td>AZERBAIJAN</td><td>Azerbaijanian Manat</td><td>AZN</td></tr><tr><td>BAHAMAS (THE)</td><td>Bahamian Dollar</td><td>BSD</td></tr><tr><td>BAHRAIN</td><td>Bahraini Dinar</td><td>BHD</td></tr><tr><td>BANGLADESH</td><td>Taka</td><td>BDT</td></tr><tr><td>BARBADOS</td><td>Barbados Dollar</td><td>BBD</td></tr><tr><td>BELARUS</td><td>Belarussian Ruble</td><td>BYN</td></tr><tr><td>BELGIUM</td><td>Euro</td><td>EUR</td></tr><tr><td>BELIZE</td><td>Belize Dollar</td><td>BZD</td></tr><tr><td>BENIN</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>BERMUDA</td><td>Bermudian Dollar</td><td>BMD</td></tr><tr><td>BHUTAN</td><td>Ngultrum</td><td>BTN</td></tr><tr><td>BHUTAN</td><td>Indian Rupee</td><td>INR</td></tr><tr><td>BOLIVIA (PLURINATIONAL STATE OF)</td><td>Boliviano</td><td>BOB</td></tr><tr><td>BOLIVIA (PLURINATIONAL STATE OF)</td><td>Mvdol</td><td>BOV</td></tr><tr><td>BONAIRE, SINT EUSTATIUS AND SABA</td><td>US Dollar</td><td>USD</td></tr><tr><td>BOSNIA AND HERZEGOVINA</td><td>Convertible Mark</td><td>BAM</td></tr><tr><td>BOTSWANA</td><td>Pula</td><td>BWP</td></tr><tr><td>BOUVET ISLAND</td><td>Norwegian Krone</td><td>NOK</td></tr><tr><td>BRAZIL</td><td>Brazilian Real</td><td>BRL</td></tr><tr><td>BRITISH INDIAN OCEAN TERRITORY (THE)</td><td>US Dollar</td><td>USD</td></tr><tr><td>BRUNEI DARUSSALAM</td><td>Brunei Dollar</td><td>BND</td></tr><tr><td>BULGARIA</td><td>Bulgarian Lev</td><td>BGN</td></tr><tr><td>BURKINA FASO</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>BURUNDI</td><td>Burundi Franc</td><td>BIF</td></tr><tr><td>CABO VERDE</td><td>Cabo Verde Escudo</td><td>CVE</td></tr><tr><td>CAMBODIA</td><td>Riel</td><td>KHR</td></tr><tr><td>CAMEROON</td><td>CFA Franc BEAC</td><td>XAF</td></tr><tr><td>CANADA</td><td>Canadian Dollar</td><td>CAD</td></tr><tr><td>CAYMAN ISLANDS (THE)</td><td>Cayman Islands Dollar</td><td>KYD</td></tr><tr><td>CENTRAL AFRICAN REPUBLIC (THE)</td><td>CFA Franc BEAC</td><td>XAF</td></tr><tr><td>CHAD</td><td>CFA Franc BEAC</td><td>XAF</td></tr><tr><td>CHILE</td><td>Unidad de Fomento</td><td>CLF</td></tr><tr><td>CHILE</td><td>Chilean Peso</td><td>CLP</td></tr><tr><td>CHINA</td><td>Yuan Renminbi</td><td>CNY</td></tr><tr><td>CHRISTMAS ISLAND</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>COCOS (KEELING) ISLANDS (THE)</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>COLOMBIA</td><td>Colombian Peso</td><td>COP</td></tr><tr><td>COLOMBIA</td><td>Unidad de Valor Real</td><td>COU</td></tr><tr><td>COMOROS (THE)</td><td>Comoro Franc</td><td>KMF</td></tr><tr><td>CONGO (THE DEMOCRATIC REPUBLIC OF THE)</td><td>Congolese Franc</td><td>CDF</td></tr><tr><td>CONGO (THE)</td><td>CFA Franc BEAC</td><td>XAF</td></tr><tr><td>COOK ISLANDS (THE)</td><td>New Zealand Dollar</td><td>NZD</td></tr><tr><td>COSTA RICA</td><td>Costa Rican Colon</td><td>CRC</td></tr><tr><td>CROATIA</td><td>Euro</td><td>EUR</td></tr><tr><td>CUBA</td><td>Peso Convertible</td><td>CUC</td></tr><tr><td>CUBA</td><td>Cuban Peso</td><td>CUP</td></tr><tr><td>CURAÇAO</td><td>Netherlands Antillean Guilder</td><td>ANG</td></tr><tr><td>CYPRUS</td><td>Euro</td><td>EUR</td></tr><tr><td>CZECH REPUBLIC (THE)</td><td>Czech Koruna</td><td>CZK</td></tr><tr><td>CÔTE D'IVOIRE</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>DENMARK</td><td>Danish Krone</td><td>DKK</td></tr><tr><td>DJIBOUTI</td><td>Djibouti Franc</td><td>DJF</td></tr><tr><td>DOMINICA</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>DOMINICAN REPUBLIC (THE)</td><td>Dominican Peso</td><td>DOP</td></tr><tr><td>ECUADOR</td><td>US Dollar</td><td>USD</td></tr><tr><td>EGYPT</td><td>Egyptian Pound</td><td>EGP</td></tr><tr><td>EL SALVADOR</td><td>El Salvador Colon</td><td>SVC</td></tr><tr><td>EL SALVADOR</td><td>US Dollar</td><td>USD</td></tr><tr><td>EQUATORIAL GUINEA</td><td>CFA Franc BEAC</td><td>XAF</td></tr><tr><td>ERITREA</td><td>Nakfa</td><td>ERN</td></tr><tr><td>ESTONIA</td><td>Euro</td><td>EUR</td></tr><tr><td>ETHIOPIA</td><td>Ethiopian Birr</td><td>ETB</td></tr><tr><td>EUROPEAN UNION</td><td>Euro</td><td>EUR</td></tr><tr><td>FALKLAND ISLANDS (THE) [MALVINAS]</td><td>Falkland Islands Pound</td><td>FKP</td></tr><tr><td>FAROE ISLANDS (THE)</td><td>Danish Krone</td><td>DKK</td></tr><tr><td>FIJI</td><td>Fiji Dollar</td><td>FJD</td></tr><tr><td>FINLAND</td><td>Euro</td><td>EUR</td></tr><tr><td>FRANCE</td><td>Euro</td><td>EUR</td></tr><tr><td>FRENCH GUIANA</td><td>Euro</td><td>EUR</td></tr><tr><td>FRENCH POLYNESIA</td><td>CFP Franc</td><td>XPF</td></tr><tr><td>FRENCH SOUTHERN TERRITORIES (THE)</td><td>Euro</td><td>EUR</td></tr><tr><td>GABON</td><td>CFA Franc BEAC</td><td>XAF</td></tr><tr><td>GAMBIA (THE)</td><td>Dalasi</td><td>GMD</td></tr><tr><td>GEORGIA</td><td>Lari</td><td>GEL</td></tr><tr><td>GERMANY</td><td>Euro</td><td>EUR</td></tr><tr><td>GHANA</td><td>Ghana Cedi</td><td>GHS</td></tr><tr><td>GIBRALTAR</td><td>Gibraltar Pound</td><td>GIP</td></tr><tr><td>GREECE</td><td>Euro</td><td>EUR</td></tr><tr><td>GREENLAND</td><td>Danish Krone</td><td>DKK</td></tr><tr><td>GRENADA</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>GUADELOUPE</td><td>Euro</td><td>EUR</td></tr><tr><td>GUAM</td><td>US Dollar</td><td>USD</td></tr><tr><td>GUATEMALA</td><td>Quetzal</td><td>GTQ</td></tr><tr><td>GUERNSEY</td><td>Pound Sterling</td><td>GBP</td></tr><tr><td>GUINEA</td><td>Guinea Franc</td><td>GNF</td></tr><tr><td>GUINEA-BISSAU</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>GUYANA</td><td>Guyana Dollar</td><td>GYD</td></tr><tr><td>HAITI</td><td>Gourde</td><td>HTG</td></tr><tr><td>HAITI</td><td>US Dollar</td><td>USD</td></tr><tr><td>HEARD ISLAND AND McDONALD ISLANDS</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>HOLY SEE (THE)</td><td>Euro</td><td>EUR</td></tr><tr><td>HONDURAS</td><td>Lempira</td><td>HNL</td></tr><tr><td>HONG KONG</td><td>Hong Kong Dollar</td><td>HKD</td></tr><tr><td>HUNGARY</td><td>Forint</td><td>HUF</td></tr><tr><td>ICELAND</td><td>Iceland Krona</td><td>ISK</td></tr><tr><td>INDIA</td><td>Indian Rupee</td><td>INR</td></tr><tr><td>INDONESIA</td><td>Rupiah</td><td>IDR</td></tr><tr><td>INTERNATIONAL MONETARY FUND (IMF) </td><td>SDR (Special Drawing Right)</td><td>XDR</td></tr><tr><td>IRAN (ISLAMIC REPUBLIC OF)</td><td>Iranian Rial</td><td>IRR</td></tr><tr><td>IRAQ</td><td>Iraqi Dinar</td><td>IQD</td></tr><tr><td>IRELAND</td><td>Euro</td><td>EUR</td></tr><tr><td>ISLE OF MAN</td><td>Pound Sterling</td><td>GBP</td></tr><tr><td>ISRAEL</td><td>New Israeli Sheqel</td><td>ILS</td></tr><tr><td>ITALY</td><td>Euro</td><td>EUR</td></tr><tr><td>JAMAICA</td><td>Jamaican Dollar</td><td>JMD</td></tr><tr><td>JAPAN</td><td>Yen</td><td>JPY</td></tr><tr><td>JERSEY</td><td>Pound Sterling</td><td>GBP</td></tr><tr><td>JORDAN</td><td>Jordanian Dinar</td><td>JOD</td></tr><tr><td>KAZAKHSTAN</td><td>Tenge</td><td>KZT</td></tr><tr><td>KENYA</td><td>Kenyan Shilling</td><td>KES</td></tr><tr><td>KIRIBATI</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>KOREA (THE DEMOCRATIC PEOPLE’S REPUBLIC OF)</td><td>North Korean Won</td><td>KPW</td></tr><tr><td>KOREA (THE REPUBLIC OF)</td><td>Won</td><td>KRW</td></tr><tr><td>KUWAIT</td><td>Kuwaiti Dinar</td><td>KWD</td></tr><tr><td>KYRGYZSTAN</td><td>Som</td><td>KGS</td></tr><tr><td>LAO PEOPLE’S DEMOCRATIC REPUBLIC (THE)</td><td>Kip</td><td>LAK</td></tr><tr><td>LATVIA</td><td>Euro</td><td>EUR</td></tr><tr><td>LEBANON</td><td>Lebanese Pound</td><td>LBP</td></tr><tr><td>LESOTHO</td><td>Loti</td><td>LSL</td></tr><tr><td>LESOTHO</td><td>Rand</td><td>ZAR</td></tr><tr><td>LIBERIA</td><td>Liberian Dollar</td><td>LRD</td></tr><tr><td>LIBYA</td><td>Libyan Dinar</td><td>LYD</td></tr><tr><td>LIECHTENSTEIN</td><td>Swiss Franc</td><td>CHF</td></tr><tr><td>LITHUANIA</td><td>Euro</td><td>EUR</td></tr><tr><td>LUXEMBOURG</td><td>Euro</td><td>EUR</td></tr><tr><td>MACAO</td><td>Pataca</td><td>MOP</td></tr><tr><td>MADAGASCAR</td><td>Malagasy Ariary</td><td>MGA</td></tr><tr><td>MALAWI</td><td>Kwacha</td><td>MWK</td></tr><tr><td>MALAYSIA</td><td>Malaysian Ringgit</td><td>MYR</td></tr><tr><td>MALDIVES</td><td>Rufiyaa</td><td>MVR</td></tr><tr><td>MALI</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>MALTA</td><td>Euro</td><td>EUR</td></tr><tr><td>MARSHALL ISLANDS (THE)</td><td>US Dollar</td><td>USD</td></tr><tr><td>MARTINIQUE</td><td>Euro</td><td>EUR</td></tr><tr><td>MAURITANIA</td><td>Ouguiya</td><td>MRU</td></tr><tr><td>MAURITIUS</td><td>Mauritius Rupee</td><td>MUR</td></tr><tr><td>MAYOTTE</td><td>Euro</td><td>EUR</td></tr><tr><td>MEMBER COUNTRIES OF THE AFRICAN DEVELOPMENT BANK GROUP</td><td>ADB Unit of Account</td><td>XUA</td></tr><tr><td>MEXICO</td><td>Mexican Peso</td><td>MXN</td></tr><tr><td>MEXICO</td><td>Mexican Unidad de Inversion (UDI)</td><td>MXV</td></tr><tr><td>MICRONESIA (FEDERATED STATES OF)</td><td>US Dollar</td><td>USD</td></tr><tr><td>MOLDOVA (THE REPUBLIC OF)</td><td>Moldovan Leu</td><td>MDL</td></tr><tr><td>MONACO</td><td>Euro</td><td>EUR</td></tr><tr><td>MONGOLIA</td><td>Tugrik</td><td>MNT</td></tr><tr><td>MONTENEGRO</td><td>Euro</td><td>EUR</td></tr><tr><td>MONTSERRAT</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>MOROCCO</td><td>Moroccan Dirham</td><td>MAD</td></tr><tr><td>MOZAMBIQUE</td><td>Mozambique Metical</td><td>MZN</td></tr><tr><td>MYANMAR</td><td>Kyat</td><td>MMK</td></tr><tr><td>NAMIBIA</td><td>Namibia Dollar</td><td>NAD</td></tr><tr><td>NAMIBIA</td><td>Rand</td><td>ZAR</td></tr><tr><td>NAURU</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>NEPAL</td><td>Nepalese Rupee</td><td>NPR</td></tr><tr><td>NETHERLANDS (THE)</td><td>Euro</td><td>EUR</td></tr><tr><td>NEW CALEDONIA</td><td>CFP Franc</td><td>XPF</td></tr><tr><td>NEW ZEALAND</td><td>New Zealand Dollar</td><td>NZD</td></tr><tr><td>NICARAGUA</td><td>Cordoba Oro</td><td>NIO</td></tr><tr><td>NIGER (THE)</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>NIGERIA</td><td>Naira</td><td>NGN</td></tr><tr><td>NIUE</td><td>New Zealand Dollar</td><td>NZD</td></tr><tr><td>NORFOLK ISLAND</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>NORTHERN MARIANA ISLANDS (THE)</td><td>US Dollar</td><td>USD</td></tr><tr><td>NORWAY</td><td>Norwegian Krone</td><td>NOK</td></tr><tr><td>OMAN</td><td>Rial Omani</td><td>OMR</td></tr><tr><td>PAKISTAN</td><td>Pakistan Rupee</td><td>PKR</td></tr><tr><td>PALAU</td><td>US Dollar</td><td>USD</td></tr><tr><td>PALESTINE, STATE OF</td><td>No universal currency</td><td></td></tr><tr><td>PANAMA</td><td>Balboa</td><td>PAB</td></tr><tr><td>PANAMA</td><td>US Dollar</td><td>USD</td></tr><tr><td>PAPUA NEW GUINEA</td><td>Kina</td><td>PGK</td></tr><tr><td>PARAGUAY</td><td>Guarani</td><td>PYG</td></tr><tr><td>PERU</td><td>Nuevo Sol</td><td>PEN</td></tr><tr><td>PHILIPPINES (THE)</td><td>Philippine Peso</td><td>PHP</td></tr><tr><td>PITCAIRN</td><td>New Zealand Dollar</td><td>NZD</td></tr><tr><td>POLAND</td><td>Zloty</td><td>PLN</td></tr><tr><td>PORTUGAL</td><td>Euro</td><td>EUR</td></tr><tr><td>PUERTO RICO</td><td>US Dollar</td><td>USD</td></tr><tr><td>QATAR</td><td>Qatari Rial</td><td>QAR</td></tr><tr><td>REPUBLIC OF NORTH MACEDONIA</td><td>Denar</td><td>MKD</td></tr><tr><td>ROMANIA</td><td>Romanian Leu</td><td>RON</td></tr><tr><td>RUSSIAN FEDERATION (THE)</td><td>Russian Ruble</td><td>RUB</td></tr><tr><td>RWANDA</td><td>Rwanda Franc</td><td>RWF</td></tr><tr><td>RÉUNION</td><td>Euro</td><td>EUR</td></tr><tr><td>SAINT BARTHÉLEMY</td><td>Euro</td><td>EUR</td></tr><tr><td>SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA</td><td>Saint Helena Pound</td><td>SHP</td></tr><tr><td>SAINT KITTS AND NEVIS</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>SAINT LUCIA</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>SAINT MARTIN (FRENCH PART)</td><td>Euro</td><td>EUR</td></tr><tr><td>SAINT PIERRE AND MIQUELON</td><td>Euro</td><td>EUR</td></tr><tr><td>SAINT VINCENT AND THE GRENADINES</td><td>East Caribbean Dollar</td><td>XCD</td></tr><tr><td>SAMOA</td><td>Tala</td><td>WST</td></tr><tr><td>SAN MARINO</td><td>Euro</td><td>EUR</td></tr><tr><td>SAO TOME AND PRINCIPE</td><td>Dobra</td><td>STN</td></tr><tr><td>SAUDI ARABIA</td><td>Saudi Riyal</td><td>SAR</td></tr><tr><td>SENEGAL</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>SERBIA</td><td>Serbian Dinar</td><td>RSD</td></tr><tr><td>SEYCHELLES</td><td>Seychelles Rupee</td><td>SCR</td></tr><tr><td>SIERRA LEONE</td><td>Leone</td><td>SLE</td></tr><tr><td>SINGAPORE</td><td>Singapore Dollar</td><td>SGD</td></tr><tr><td>SINT MAARTEN (DUTCH PART)</td><td>Netherlands Antillean Guilder</td><td>ANG</td></tr><tr><td>SISTEMA UNITARIO DE COMPENSACION REGIONAL DE PAGOS "SUCRE"</td><td>Sucre</td><td>XSU</td></tr><tr><td>SLOVAKIA</td><td>Euro</td><td>EUR</td></tr><tr><td>SLOVENIA</td><td>Euro</td><td>EUR</td></tr><tr><td>SOLOMON ISLANDS</td><td>Solomon Islands Dollar</td><td>SBD</td></tr><tr><td>SOMALIA</td><td>Somali Shilling</td><td>SOS</td></tr><tr><td>SOUTH AFRICA</td><td>Rand</td><td>ZAR</td></tr><tr><td>SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS</td><td>No universal currency</td><td></td></tr><tr><td>SOUTH SUDAN</td><td>South Sudanese Pound</td><td>SSP</td></tr><tr><td>SPAIN</td><td>Euro</td><td>EUR</td></tr><tr><td>SRI LANKA</td><td>Sri Lanka Rupee</td><td>LKR</td></tr><tr><td>SUDAN (THE)</td><td>Sudanese Pound</td><td>SDG</td></tr><tr><td>SURINAME</td><td>Surinam Dollar</td><td>SRD</td></tr><tr><td>SVALBARD AND JAN MAYEN</td><td>Norwegian Krone</td><td>NOK</td></tr><tr><td>SWAZILAND</td><td>Lilangeni</td><td>SZL</td></tr><tr><td>SWEDEN</td><td>Swedish Krona</td><td>SEK</td></tr><tr><td>SWITZERLAND</td><td>WIR Euro</td><td>CHE</td></tr><tr><td>SWITZERLAND</td><td>Swiss Franc</td><td>CHF</td></tr><tr><td>SWITZERLAND</td><td>WIR Franc</td><td>CHW</td></tr><tr><td>SYRIAN ARAB REPUBLIC</td><td>Syrian Pound</td><td>SYP</td></tr><tr><td>TAIWAN (PROVINCE OF CHINA)</td><td>New Taiwan Dollar</td><td>TWD</td></tr><tr><td>TAJIKISTAN</td><td>Somoni</td><td>TJS</td></tr><tr><td>TANZANIA, UNITED REPUBLIC OF</td><td>Tanzanian Shilling</td><td>TZS</td></tr><tr><td>THAILAND</td><td>Baht</td><td>THB</td></tr><tr><td>TIMOR-LESTE</td><td>US Dollar</td><td>USD</td></tr><tr><td>TOGO</td><td>CFA Franc BCEAO</td><td>XOF</td></tr><tr><td>TOKELAU</td><td>New Zealand Dollar</td><td>NZD</td></tr><tr><td>TONGA</td><td>Pa’anga</td><td>TOP</td></tr><tr><td>TRINIDAD AND TOBAGO</td><td>Trinidad and Tobago Dollar</td><td>TTD</td></tr><tr><td>TUNISIA</td><td>Tunisian Dinar</td><td>TND</td></tr><tr><td>TURKEY</td><td>Turkish Lira</td><td>TRY</td></tr><tr><td>TURKMENISTAN</td><td>Turkmenistan New Manat</td><td>TMT</td></tr><tr><td>TURKS AND CAICOS ISLANDS (THE)</td><td>US Dollar</td><td>USD</td></tr><tr><td>TUVALU</td><td>Australian Dollar</td><td>AUD</td></tr><tr><td>UGANDA</td><td>Uganda Shilling</td><td>UGX</td></tr><tr><td>UKRAINE</td><td>Hryvnia</td><td>UAH</td></tr><tr><td>UNITED ARAB EMIRATES (THE)</td><td>UAE Dirham</td><td>AED</td></tr><tr><td>UNITED KINGDOM OF GREAT BRITAIN AND NORTHERN IRELAND (THE)</td><td>Pound Sterling</td><td>GBP</td></tr><tr><td>UNITED STATES MINOR OUTLYING ISLANDS (THE)</td><td>US Dollar</td><td>USD</td></tr><tr><td>UNITED STATES OF AMERICA (THE)</td><td>US Dollar</td><td>USD</td></tr><tr><td>UNITED STATES OF AMERICA (THE)</td><td>US Dollar (Next day)</td><td>USN</td></tr><tr><td>URUGUAY</td><td>Uruguay Peso en Unidades Indexadas (URUIURUI)</td><td>UYI</td></tr><tr><td>URUGUAY</td><td>Peso Uruguayo</td><td>UYU</td></tr><tr><td>UZBEKISTAN</td><td>Uzbekistan Sum</td><td>UZS</td></tr><tr><td>VANUATU</td><td>Vatu</td><td>VUV</td></tr><tr><td>VENEZUELA (BOLIVARIAN REPUBLIC OF)</td><td>Bolivar</td><td>VEF</td></tr><tr><td>VENEZUELA (BOLIVARIAN REPUBLIC OF)</td><td>Bolivar</td><td>VED</td></tr><tr><td>VIET NAM</td><td>Dong</td><td>VND</td></tr><tr><td>VIRGIN ISLANDS (BRITISH)</td><td>US Dollar</td><td>USD</td></tr><tr><td>VIRGIN ISLANDS (U.S.)</td><td>US Dollar</td><td>USD</td></tr><tr><td>WALLIS AND FUTUNA</td><td>CFP Franc</td><td>XPF</td></tr><tr><td>WESTERN SAHARA</td><td>Moroccan Dirham</td><td>MAD</td></tr><tr><td>YEMEN</td><td>Yemeni Rial</td><td>YER</td></tr><tr><td>ZAMBIA</td><td>Zambian Kwacha</td><td>ZMW</td></tr><tr><td>ZIMBABWE</td><td>Zimbabwe Dollar</td><td>ZWL</td></tr><tr><td>ÅLAND ISLANDS</td><td>Euro</td><td>EUR</td></tr></tbody></table>


# Document Types

An API to help you get information about the types of documents allowed for the country you want to work.

***

### <mark style="color:green;">GET</mark> /documents-type

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/documents-type?country=BRA' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="138.33333333333331">Parameter</th><th width="197" align="center">Type</th><th width="103">Required</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>country</code></mark></td><td align="center"><mark style="color:red;"><code>string (3)</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td><strong>yes</strong></td><td>This parameter is required. Please, choose a country.<br><br><strong>Eg.: BRA, COL, ECU ...</strong></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```bash
{
    "requestId": "167ffff1-b58b-4d1b-909e-ff714c594967",
    "data": [
        {
            "id": 1,
            "abbreviation": "CPF",
            "name": "Cadastro de Pessoa Física",
            "country": "BRA",
            "regex_validation": null
        },
        {
            "id": 2,
            "abbreviation": "CNPJ",
            "name": "Cadastro Nacional de Pessoa Jurídica",
            "country": "BRA",
            "regex_validation": null
        }
    ]
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="189">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>abbreviation</code></mark></td><td>Acronym for document type abbreviation</td></tr><tr><td><mark style="color:red;"><code>name</code></mark></td><td>Document type name</td></tr><tr><td><mark style="color:red;"><code>country</code></mark></td><td>Country</td></tr><tr><td><mark style="color:red;"><code>regex_validation</code></mark></td><td>Regex validation (if there is)</td></tr></tbody></table>


# List Bank Codes

An API to help you get information about the list of banks allowed for the country you want to work.

***

### <mark style="color:green;">GET</mark> /v2/list-banks

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v2/list-banks?country=ECU' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="138.33333333333331">Parameter</th><th width="197" align="center">Type</th><th width="103">Required</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>country</code></mark></td><td align="center"><mark style="color:red;"><code>string (3)</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td><strong>yes</strong></td><td>This parameter is required. Please, choose a country.<br><br><strong>Eg.: BRA, ARG, BOL, CHL, COL, ECU, MEX, PER...</strong></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```bash
{
    "requestId": "167ffff1-b58b-4d1b-909e-ff714c594967",
    "data": [
        {
            "code": "0017",
            "name": "Banco_de_guayaquil_sa",
            "description": "Banco de Guayaquil SA",
        },
        {
            "code": "0024",
            "name": "Banco_city_bank",
            "description": "Banco City Bank",
        }
    ]
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="189">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>code</code></mark></td><td>Code of the Bank</td></tr><tr><td><mark style="color:red;"><code>name</code></mark></td><td>Name of the Bank - Slug</td></tr><tr><td><mark style="color:red;"><code>description</code></mark></td><td>Name of the Bank</td></tr></tbody></table>


# Wallet

Call the Wallet API to request balance wallet.

***

### <mark style="color:green;">GET</mark> /balance

{% hint style="info" %}
**Request**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/balance' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

```bash
# With parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/balance?currency=USD' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="138.33333333333331">Parameter</th><th width="188" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>currency</code></mark></td><td align="center"><mark style="color:red;"><code>string (3)</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td>This parameter is optional, if currency isn't provided it will return all currencies.<br><strong>Eg.: USD</strong></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```bash
# All Currencies
{
    "requestId": "167ffff1-b58b-4d1b-909e-ff714c594967",
    "data": [
        {
            "currency": "BRL",
            "balance": 517488.21
        },
        {
            "currency": "USD",
            "balance": 53.62
        }
    ]
}
```

```bash
# One Currency
{
    "requestId": "167ffff1-b58b-4d1b-909e-ff714c594967",
    "data": [
        {
            "currency": "BRL",
            "balance": 517488.21
        }
    ]
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="155">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount.</td></tr><tr><td><mark style="color:red;"><code>balance</code></mark></td><td>Balance value.</td></tr></tbody></table>


# Our Status and Flow

When you make a request to our API using the **POST** method, it generates a transaction that is categorized as either a **payment** or a **payout**.

Below, we explain in detail each status that a transaction can have.<br>

{% hint style="info" %}
**Transaction**
{% endhint %}

<figure><img src="/files/BFiPlTZ507qQ9xbpEsG3" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="130">Status</th><th>Description</th></tr></thead><tbody><tr><td>open</td><td>When using the API <strong>/transaction/checkout</strong>, the initial status of the transaction is open. It means that a transaction has been initiated but the requester has not yet assigned a payment method on our page.</td></tr><tr><td>pending</td><td>When using the API <strong>/payment</strong> or <strong>/payout</strong>, the initial status of the transaction is pending. It means that a transaction has been initiated and automatically assigned (as sent in the payload) a payment or payout method.</td></tr><tr><td>paid</td><td>When a transaction is successfully completed and processed, the transaction status is paid.</td></tr><tr><td>canceled</td><td>When a transaction fails for any reason, the transaction status becomes canceled</td></tr></tbody></table>

The types of transactions, also known as **sub-transactions**, work almost like a log of the transaction's evolution. Below is a brief description of each status and a flowchart of the evolution of the statuses.<br>

{% hint style="info" %}
**Payment**
{% endhint %}

<figure><img src="/files/XxxNKZ9H8ITEKJz8HfrN" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="141">Status</th><th>Description</th></tr></thead><tbody><tr><td>pending</td><td>All payment-type transactions have the pending status as the <strong>initial status</strong>.</td></tr><tr><td>paid</td><td>When a payment is successfully completed and processed, the transaction status is paid.</td></tr><tr><td>denied</td><td>When a payment does not meet our <strong>payment policies</strong>, it is denied, and therefore our status becomes denied.</td></tr><tr><td>expired</td><td>Whenever a payment order is opened, it has a <strong>period for payment</strong>. When the period is reached, the order expires, making it no longer possible to pay.</td></tr><tr><td>chargeback</td><td>Whenever a payment order is <strong>paid</strong>, then the customer <strong>requests a chargeback</strong> in their bank, this status symbolizes that the value of this transactions is no longer available</td></tr><tr><td>blocked</td><td><p>This status symbolizes that the value of this transaction is blocked for various reasons.<br>Examples:<br></p><ul><li>Compliance</li><li>Legal</li><li>Fraud control</li><li>...</li></ul><p>For more information, contact the administration.</p></td></tr></tbody></table>

{% hint style="info" %}
**Payout**
{% endhint %}

<figure><img src="/files/kBJ5uUTAnOOe6jzIzbe3" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="126">Status</th><th>Description</th></tr></thead><tbody><tr><td>pending</td><td>All payout-type transactions have the pending status as the <strong>initial status</strong></td></tr><tr><td>onhold</td><td>When the payout request is sent for processing, it receives the onhold status, meaning it is <strong>waiting for the bank</strong> to make the payment to proceed with success or failure</td></tr><tr><td>success</td><td>When a payout is successfully completed and processed, the transaction status is success.</td></tr><tr><td>failed</td><td>When a payout does not meet our <strong>payment policies</strong> or we cannot process it due to various problems, it fails, and therefore our status becomes failed.</td></tr><tr><td>blocked</td><td><p>This status symbolizes that the value of this transaction is blocked for various reasons.<br>Examples:</p><ul><li>Compliance</li><li>Legal</li><li>Fraud control</li><li>...</li></ul><p>For more information, contact the administration.</p></td></tr><tr><td>returned</td><td>In some cases, the <strong>banking institution</strong> returns the received amount, in which case the status becomes returned.</td></tr><tr><td>refunded</td><td>In some cases, the <strong>customer</strong> returns the received amount, in which case the status becomes refunded.</td></tr></tbody></table>


# Notification & Webhooks


# Notifications

Our APIs use webhooks for event notifications. Webhooks are push API calls that let your app know an event has happened.

In order to receive notifications about the events in your platform, you have to previously configure the notification when you do the <mark style="color:red;">`POST`</mark> of the transaction, indicating the URL in the field <mark style="color:red;">`callback`</mark>.

### Event

Whenever an event occurs, we will send you a notification in json format using HTTP POST to the URL that you specified.

Each JSON-formatted POST notification message contains event information based on the resource type and the event type.

> **Note:** If your app responds with any other status code, we tries to resend the notification message 5 times over the course of three days.

### Security - To prevent downgrade attacks

Every notification we send to your endpoint is signed. We do this by including a header named <mark style="color:red;">`"SmartFastPay-Signature"`</mark> in every event we send. This allows you to verify and ensure that the event was sent by SmartFastPay and not a third party.

### Notification example

An example of a successful **payment notification**:<br>

{% hint style="info" %}
**Successful Payment Notification**
{% endhint %}

```json
{
  "callback": true,
  "data": [
    {
      "id": "9f141523-8a70-4723-8c2a-6fc196a31d46",
      "customer_id": "997a840a-c340-4a69-9da1-fdc155c2e607",
      "transaction_id": "93c8a113-2ab7-452c-a466-b417da33db44",
      "amount": "200.00000000",
      "currency": "BRL",
      "status": "paid",
      "status_details": "Error detail if canceled",
      "type": "payment",
      "payment_method": "pix",
      "payment_status": "paid",
      "exchange": "1.00"
    }
  ]
}
```

{% hint style="info" %}
**Notification data details**
{% endhint %}

An example of an unsuccessful **payout notification**

{% hint style="info" %}
**Unsuccessful Payout Notification**
{% endhint %}

```json
{
  "callback": true,
  "data": [
    {
      "id": "9f141523-8a70-4723-8c2a-6fc196a31d46",
      "customer_id": "997a840a-c340-4a69-9da1-fdc155c2e607",
      "transaction_id": "93c8a113-2ab7-452c-a466-b417da33db44",
      "amount": "200.00000000",
      "currency": "BRL",
      "status": "canceled",
      "status_details": "Error detail if canceled",
      "type": "payout",
      "payout_status": "failed",
      "exchange": "1.00"
    }
  ]
}
```

{% hint style="info" %}
**Notification data details**
{% endhint %}

<table><thead><tr><th width="198">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created transaction by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the transaction. These are our statuses: <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>canceled</code></mark></td></tr><tr><td><mark style="color:red;"><code>status_details</code></mark></td><td>This field describes the reason for the transaction cancellation.</td></tr><tr><td><mark style="color:red;"><code>type</code></mark></td><td>Shows the type of this transaction. <mark style="color:red;"><code>payment</code></mark> or <mark style="color:red;"><code>payout</code></mark></td></tr><tr><td><mark style="color:red;"><code>payout_status</code></mark></td><td>The current status of the payout. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>success</code></mark>, <mark style="color:red;"><code>failed</code></mark>, <mark style="color:red;"><code>onhold</code></mark>, <mark style="color:red;"><code>returned</code></mark>, <mark style="color:red;"><code>refunded</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment_status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>chargeback</code></mark></td></tr><tr><td><mark style="color:red;"><code>exchange</code></mark></td><td>The exchange rate applied to the current transaction</td></tr></tbody></table>


# Get Secret

Get the secret to use in Webhook Signature.

***

### <mark style="color:green;">GET</mark> /webhook/secret

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/webhook/secret' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
Response
{% endhint %}

```bash
{
    "requestId": "4602ded8-9377-44a5-b29a-1fa9ea788dd2",
    "data": {
        "secret": "b52473b92-122c-4322-ad3b-0c9e6c378e54"
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="131">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>secret</code></mark></td><td>Secret to use in Webhook Signature.</td></tr></tbody></table>


# Events Signature

Every notification we send to your endpoint is signed. We do this by including a header named <mark style="color:red;">`"SmartFastPay-Signature"`</mark> in every event we send. This allows you to verify and ensure that the event was sent by SmartFastPay and not a third party.

The <mark style="color:red;">`"SmartFastPay-Signature"`</mark> header contains a <mark style="color:red;">`timestamp`</mark> and one or more signatures. The <mark style="color:red;">`timestamp`</mark> is prefixed by <mark style="color:red;">`t=`</mark> and each signature is prefixed by a schema. Schemas start with <mark style="color:red;">`v`</mark> followed by an <mark style="color:red;">`integer`</mark>. Currently there is only one signature schema which is <mark style="color:red;">`v1`</mark>.

Exemplo do Header SmartFastPay-Signature:

```json
SmartFastPay-Signature: t=1681235417000,v1=b9ffafcd16416bd11e36f877c2d7ccc71633d174f8245abc49fc2aef7e6633c8
```

Signatures are generated using a hashed message based authentication code <mark style="color:red;">`(HMAC)`</mark> with <mark style="color:red;">`SHA-256`</mark>. To prevent downgrade attacks, you must ignore all non-v1 schemas.

***

### How to validate the signature

#### Step 1: Extract the Timestamp and Signature from the Header

Split the header using the character as a separator to get the list of elements. Once that's done, do another split using the <mark style="color:red;">`=`</mark> character as a separator, to get the prefix and the value.

The value obtained from the <mark style="color:red;">`t`</mark> prefix corresponds to the timestamp and the <mark style="color:red;">`v1`</mark> corresponds to the signature. You can discard other values.<br>

#### Step 2: Prepare the string to compare signatures

You must concatenate this information:

* The timestamp (as <mark style="color:red;">`string`</mark>)
* The character <mark style="color:red;">`.`</mark>
* The JSON payload (request body, in <mark style="color:red;">`string`</mark> format)

Compute the <mark style="color:red;">`HMAC`</mark> with the <mark style="color:red;">`SHA256`</mark> hash function. Use the **secret (see what your secret is by** [**clicking here**](/thesmartway/notification-and-webhooks/secret) **)**.<br>

Example in PHP:

```php
<?php

// This secret is not the secret of the authentication token, it is the UID
$secret = 'my-secret';

// This is the "t" value received on SmartFastPay-Signature header
$timestamp = 1681235417000;

$requestPayload = [
    "callback" => true,
    "data" => [
        [
            "id" => "cc467b71-922d-415c-9394-52659613f3d7",
            "customer_id" => "718182ae-d2e0-4028-946d-ce66993df587",
            "transaction_id" => "7d47a163-d37d-4768-825d-8d3ef9733283",
            "amount" => "111.00000000",
            "currency" => "BRL",
            "status" => "paid",
            "status_details" => "",
            "type" => "payment",
            "payment_status" => "paid",
            "exchange" => "1.00"
        ]
    ]
];

$jsonPayload = json_encode($requestPayload, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);

$paramsSignature = "{$timestamp}.{$jsonPayload}";

echo hash_hmac('sha256', $paramsSignature, $secret);

// Output: b9ffafcd16416bd11e36f877c2d7ccc71633d174f8245abc49fc2aef7e6633c8
```

#### Step 3: Compare signatures

Compare the signature sent by SmartFastPay in the Header with the signature you generated in **Step 2**.<br>

Example in PHP:

```php
<?php

// Comparing Signatures
// Example Header of the request sent by SmartFastPay:
$headers = [
    'SmartFastPay-Signature' => 't=1681235417000,v1=b9ffafcd16416bd11e36f877c2d7ccc71633d174f8245abc49fc2aef7e6633c8'
];

// Extract the value of 't' from Header 'SmartFastPay-Signature'
// '1681235417000'
$timestamp = explode("=", explode(",", $headers['SmartFastPay-Signature'])[0])[1];

// Extract the value of 'v1' from Header 'SmartFastPay-Signature'
// 'b9ffafcd16416bd11e36f877c2d7ccc71633d174f8245abc49fc2aef7e6633c8'
$signature = explode("=", explode(",", $headers['SmartFastPay-Signature'])[1])[1];

// The Signature you generated in Step 2 must be equal to the value of the "$signature" variable.
// Must return 1 (true)
echo ('yourSignature' === $signature);
```


# PayIn


# Overview

Call the Payments API to request host-to-host payin methods.

The API parameters are organized into distinct objects to streamline the payment process and ensure clarity in data handling. Each object represents a specific aspect of the transaction, making it easier to manage and understand the flow of information. However, some parameters stand alone and are not part of any object. Below is an overview of the objects and their corresponding parameters, as well as the standalone parameters:

* **Customer**: Represents the individual making the payment. This object includes critical information about the customer, such as their unique ID, name, email address, and optionally, their IP address and birthdate. The **customer.document** sub-object details the type and number of the customer's official identification, while the **customer.address** sub-object includes the customer's full address, which may be required depending on the payment method.
* **Transaction**: This object contains all the essential details about the transaction itself, including a unique transaction ID, the currency used, the total amount involved, and optionally, the time until the transaction expires.
* **Payment**: Represents the payment method and related URLs for completing the transaction. This object is crucial for determining how the customer will pay and where they will be redirected after the payment is completed.
* **Values**: This object provides detailed financial information related to the transaction. It includes the original and converted amounts, the currencies involved, the exchange rate applied, and any fees associated with the transaction.

Standalone parameters, such as **branch**, **country**, **notification\_url**, and **redirect\_url**, do not belong to any specific object. These parameters provide additional information relevant to the transaction, such as the location of the transaction, the country code, where payment notifications should be sent, and where the customer should be redirected after completing the payment.

Our API structure remains consistent across different payment methods and countries, making it easy to adapt as you expand into new regions or integrate new methods.

{% hint style="info" %}
**Knowing the parameters used**
{% endhint %}

<table><thead><tr><th width="346">Parameter</th><th width="120" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>redirect_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page</td></tr></tbody></table>

{% hint style="info" %}
**Example response payment method request**
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "picpay",
            "qr_code": "00...014COM.PICPAY.P2B0164https:\\app.picpay.com\checkout\SMARTFASTPAY...AY6009SAO PAULXXXXX",
            "url": "https:\\app.picpay.com\checkout\SMARTFASTPAY",
            "name": "Viacredi", // only payment method is bank_transfer
            "code": "085", // only payment method is bank_transfer
            "agency": "0101-5", // only payment method is bank_transfer
            "account": "12551163", // only payment method is bank_transfer
            "account_operation": "Conta Corrente", // only payment method is bank_transfer
            "document": "34.911.051/0001-97", // only payment method is bank_transfer
            "beneficiary": "SmartFastPay" // only payment method is bank_transfer
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "BRL",
            "exchanged_total": 27525.47,
            "exchanged_currency": "BRL",
            "exchange": 1.00,
            "fee": 92.5226
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="296">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>A unique identifier for the response generated by the payment system, used to track the transaction. Can be used to verify the payment status in the<br> <a href="/pages/2xJzbjonZPNSiMSJm6MU#get-payment-id"><mark style="color:green;"><strong>GET</strong> /payment/{id}</mark></a> endpoint</td></tr><tr><td><code>status</code></td><td>The current status of the transaction such as <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><code>expires_in</code></td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>payment.method</code></td><td>The payment method that was used for the transaction, such as <mark style="color:red;"><code>bank_transfer</code></mark>, <mark style="color:red;"><code>credit_card</code></mark>, <mark style="color:red;"><code>picpay</code></mark>...</td></tr><tr><td><code>payment.url</code></td><td>The URL provided to the customer for completing the payment. This might be a redirect to a bank or payment gateway</td></tr><tr><td><code>payment.qr_code</code></td><td>The string that contains the information of the qrcode. It is necessary to use some programming resource to convert this text into an image</td></tr><tr><td><code>payment.qr_url</code></td><td>This parameter holds the content of the <code>payment.qr_code</code> parameter string, already converted into an image.</td></tr><tr><td></td><td></td></tr><tr><td>bank info</td><td><mark style="color:red;">only bank_transfer</mark></td></tr><tr><td><code>payment.name</code></td><td>Name of the bank where the deposit is going to be made</td></tr><tr><td><code>payment.code</code></td><td>Brazilian code of the bank to which the deposit is going to be directed</td></tr><tr><td><code>payment.agency</code></td><td>Agency number with verification digit to which the deposit is going to be directed</td></tr><tr><td><code>payment.account</code></td><td>Account number with verification digit to which the deposit is going to be directed</td></tr><tr><td><code>payment.account_operation</code></td><td>Either it's a savings account or a current account. <mark style="color:red;"><code>current account</code></mark>, <mark style="color:red;"><code>saving account</code></mark></td></tr><tr><td><code>payment.document</code></td><td>Either the owner document or the company document for the account to which the deposit is going to be directed</td></tr><tr><td><code>payment.beneficiary</code></td><td>Name of the owner of the account to which the deposit is going to be direct</td></tr><tr><td></td><td></td></tr><tr><td><code>values.source_total</code></td><td>The total amount of the transaction in the source currency before any exchange</td></tr><tr><td><code>values.source_currency</code></td><td>The original currency of the transaction as specified in the request</td></tr><tr><td><code>values.exchanged_total</code></td><td>The total amount of the transaction after currency conversion, if applicable</td></tr><tr><td><code>values.exchanged_currency</code></td><td>The currency in which the payment was completed after conversion</td></tr><tr><td><code>values.exchange</code></td><td>The exchange rate applied to convert the source currency to the target currency</td></tr><tr><td><code>values.fee</code></td><td>The amount charged by our service for processing the transaction</td></tr></tbody></table>

> **Note:**
>
> The **`payment.qr_code`** parameter can be provided in different formats depending on the scenario. **You might receive both a URL and a QR code, or just one of them**. In the example below, the payment method "picpay" includes both a QR code and a URL. Depending on the implementation, you may only need to use one of these elements, or both, to facilitate the payment process.

```json
"payment": {
    "method": "picpay",
    "qr_code": "00...014COM.P2B0164https:\\app.smartfastpay.com\checkout",
    "qr_url": "https://storage/qrcode_link",
    "url": "https:\\app.picpay.com\checkout\SMARTFASTPAY"
},
```

***

Our API is **designed to be flexible and adaptable**, so as you expand into new regions or add more payment methods, you can easily apply these principles across different implementations.

If you need further details on other payment methods or countries, be sure to explore the rest of our documentation. Additionally, we have a **dedicated FAQ and support section** to help with common questions:

{% content-ref url="/pages/sG2x9TC0UHqtsQdZkvWZ" %}
[FAQ & Support](/resources/faq-and-support)
{% endcontent-ref %}


# LATAM


# Brazil


# PIX

Call the Payments API to request payments via PIX.

***

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "81401e09-a227-46ac-8890-03eb225a920a",
            "name": "John Doe",
            "email": "john.doe@teste.com",
            "document": {
                "type": "CPF",
                "number": "12345678909"
            },
            "phone": "+5511912345678"
        },
        "country": "BRA",
        "payment_method": "pix",
        "notification_url": "https://my-notification-url.site",
        "transaction": {
            "id": "9fff0686-6866-445b-a540-2e96d827b7d5",
            "currency": "BRL",
            "amount": 12.61,
            "expire": 3600
        }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CPF or CNPJ)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CPF</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(BRL or USD)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: BRL</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

```json
{
	"requestId": "32fd061c0204e57b3f8524fd631d39e4\/8624435106531446739;o=1",
	"data": {
		"id": "642b6be0-7f47-4a98-98f1-f074b65ec928",
		"status": "pending",
		"expires_in": 1727126892,
		"payment": {
			"method": "pix",
			"qr_code": "00020101021226790014br.gov.bcb.pix2557brcode",
			"qr_url": "https://storage/qrcode_link",
			"url": "https://checkout-smartfastpay.com/v1/67564udfuig..."
		},
		"values": {
			"source_total": "12.61000000",
			"source_currency": "BRL",
			"exchanged_total": "12.61",
			"exchanged_currency": "BRL",
			"exchange": "1.00",
			"fee": "0.12610000"
		}
	}
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Bank Transfer

Call the Payments API to request payments via Bank Transfer.

***

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813dda",
            "name": "John Doe",
            "email": "john.doe@teste.com",
            "document": {
                "type": "CPF",
                "number": "12345678909"
            },
            "phone": "+5511912345678",
            "address": {
                "address_1": "Rua da avenida",
                "address_2": "Quadra 01",
                "number": "100",
                "neighborhood": "Londrina",
                "city": "Florianópolis",
                "state": "SC",
                "postal_code": "12332-343",
                "country_code": "BRA"
            }
        },
        "country": "BRA",
        "payment_method": "bank_transfer",
        "notification_url": "https://webhook.site/5463456345",
        "transaction": {
            "id": "b7178a51-3c86-4c08-80ac-49f2b93c58bc",
            "currency": "BRL",
            "amount": 2
        }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CPF or CNPJ)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CPF</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(BRL or USD)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: BRL</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
	"requestId": "b0d4ce65376a0bdf56b5915f15716a7e\/13632421363164131220;o=1",
	"data": {
		"id": "8f575adf-b5e9-4abc-a681-2a7825f0d4ab",
		"status": "pending",
		"expires_in": 1727212815,
		"payment": {
			"method": "bank_transfer",
			"name": "Viacredi",
			"code": "085",
			"agency": "0101-5",
			"account": "12551163",
			"account_operation": "Conta Corrente",
			"document": "34.911.051\/0001-97",
			"beneficiary": "SmartFastPay"
		},
		"values": {
			"source_total": "2.00000000",
			"source_currency": "BRL",
			"exchanged_total": "2.00",
			"exchanged_currency": "BRL",
			"exchange": "1.00",
			"fee": "0.02000000"
		}
	}
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Credit Card

Call the Credit Card API to request payments via Credit Card.

***

### <mark style="color:orange;">POST</mark> /credit\_card

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/credit_card' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer < Access-Token >' \
    --data-raw '{
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": "16972691419",
        "amount": 300,
        "currency": "BRL",
        "max_installments": 4,
        "callback": "http://mysite.com/api/notification",
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277"
            "redirect": {
                "url": "http://mysite.com/success_payment"
            }
        }
    }'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="211">Parameter</th><th width="196" align="center">Type</th><th width="100" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>branch</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>When the merchant needs to keep track of its various offices / branch, this field must be fill.</td></tr><tr><td><mark style="color:red;"><code>name</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 3 | max: 150</code></mark></td><td align="center"><strong>yes</strong></td><td>Name of the customer who started the transaction.</td></tr><tr><td><mark style="color:red;"><code>email</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>Email of the customer who started the transaction.</td></tr><tr><td><mark style="color:red;"><code>document</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>Brazilian document (CPF) of the customer who started the transaction.<br>- Must be a valid CPF document;<br><mark style="color:red;"><code>Eg: 12345678909</code></mark></td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td align="center"><mark style="color:red;"><code>decimal (10,2)</code></mark><br><mark style="color:red;"><code>min: 2</code></mark></td><td align="center"><strong>yes</strong></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td align="center"><mark style="color:red;"><code>string (3)</code></mark><br><mark style="color:red;"><code>(USD or BRL)</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td align="center">no</td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.<br><br>This parameter is optional, if currency isn't provided it will auto-select BRL.<br><strong>Default: BRL</strong></td></tr><tr><td><mark style="color:red;"><code>max_installments</code></mark></td><td align="center"><mark style="color:red;"><code>numeric</code></mark><br><mark style="color:red;"><code>min: 1 | max: 12</code></mark></td><td align="center"><strong>yes</strong></td><td>Determine the maximum number of installments allowed</td></tr><tr><td><mark style="color:red;"><code>callback</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 250</code></mark><br><mark style="color:red;"><code>(Method: POST)</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL in you site that our API will notify when the payment changes the status, the HTTP supported method should be HTTP<br><mark style="color:red;"><code>Eg: http://my-url-callback/</code></mark></td></tr><tr><td><mark style="color:red;"><code>transaction</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>redirect</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>url</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 250</code></mark></td><td align="center">no</td><td>After completing a transaction, we will redirect to this link if it exists.</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "2840429ae5547ede3850f7464ec3a1cd\15166459175723748126;o=1",
    "data": {
        "id": "11acb6a4-ea1d-4bf6-a87d-3f7b5c0340f9",
        "status": "pending",
        "expires_in": 1681219918,
        "payment": {
            "method": "credit_card"
        },
        "values": {
            "total": "28.00",
            "subtotal": "28.00",
            "exchange": "1.00",
            "fee": 0
        },
        "credit_card": {
            "url": "https:\\app.credit-card.com\checkout\NjQzNTVhNDc3OWNiYzk0MTBjN2ViMWU2"
        }
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="174">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator. Can be used to verify the payment status in the <a href="/pages/2xJzbjonZPNSiMSJm6MU#get-payment-id"><mark style="color:green;"><strong>GET</strong> /payment/{id}</mark></a> endpoint</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>expires_in</code></mark></td><td>Limit date to receive the payment</td></tr><tr><td><mark style="color:red;"><code>payment</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td>credit_card</td></tr><tr><td><mark style="color:red;"><code>values</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>total</code></mark></td><td>The full value of the transaction, including service fees. Decimal separator it a dot</td></tr><tr><td><mark style="color:red;"><code>subtotal</code></mark></td><td>The value of the transaction, without service fees. Decimal separator it a dot</td></tr><tr><td><mark style="color:red;"><code>exchange</code></mark></td><td>The exchange rate applied to the current transaction</td></tr><tr><td><mark style="color:red;"><code>fee</code></mark></td><td>The service fee value</td></tr><tr><td><mark style="color:red;"><code>credit_card</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>url</code></mark></td><td>String to open credit card checkout.</td></tr></tbody></table>


# Boleto

Call the Boleto API to request payments via banking billet (boleto bancário).

***

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813dda",
            "name": "John Doe",
            "email": "john.doe@teste.com",
            "document": {
                "type": "CPF",
                "number": "12345678909"
            },
            "phone": "+5511912345678",
            "address": {
                "address_1": "Rua da avenida",
                "address_2": "Quadra 01",
                "number": "100",
                "neighborhood": "Londrina",
                "city": "Florianópolis",
                "state": "SC",
                "postal_code": "12332-343",
                "country_code": "BRA"
            }
        },
        "country": "BRA",
        "payment_method": "boleto",
        "notification_url": "https://webhook.site/asdfasdf",
        "transaction": {
            "id": "b7178a51-3c86-4c08-80ac-49f2b93c58bc",
            "currency": "BRL",
            "amount": 2
        }
    }'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CPF or CNPJ)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CPF</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(BRL or USD)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: BRL</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
	"requestId": "67437fd917d0d7ebc5b361aa6cba01c6\/17091068426296675474",
	"data": {
		"id": "24d075a2-2b97-44a4-b9d8-5f25bbbc5c95",
		"status": "pending",
		"expires_in": 1727213203,
		"payment": {
			"method": "boleto",
			"url": "https:\/\/sandbox-checkout.smartfastpay.com\/boleto\/c307e2b5-87987fsdfgsgf",
			"bar_code": "34191.09164 767678 8768 6876 7867 897689689679768"
		},
		"values": {
			"source_total": "2.00000000",
			"source_currency": "BRL",
			"exchanged_total": "2.00",
			"exchanged_currency": "BRL",
			"exchange": "1.00",
			"fee": "0.02000000"
		}
	}
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# PicPay

Call the PicPay API to request payments via PicPay.

***

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer < Access-Token >' \
    --data-raw '{
        "customer": {
            "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813dda",
            "name": "John Doe",
            "email": "john.doe@teste.com",
            "document": {
                "type": "CPF",
                "number": "12345678909"
            },
            "phone": "+5511912345678"
        },
        "country": "BRA",
        "payment_method": "picpay",
        "notification_url": "https://webhook.site/asdfasdf",
        "transaction": {
            "id": "b7178a51-3c86-4c08-80ac-49f2b93c58bcert",
            "currency": "BRL",
            "amount": 2
        }
    }'
```

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CPF or CNPJ)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CPF</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(BRL or USD)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: BRL</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
	"requestId": "d611b6bbbc36b00edee0559ebe8ac9b7\/2373436675337331458",
	"data": {
		"id": "79dfbca4-4d98-489f-b1cd-c63449dacce5",
		"status": "pending",
		"expires_in": 1727213506,
		"payment": {
			"method": "picpay",
			"url": "https:\/\/app.picpay.com\/checkout\/asdhf",
			"qr_code": "00020101021226860014COM.PICPAY"
		},
		"values": {
			"source_total": "2.00000000",
			"source_currency": "BRL",
			"exchanged_total": "2.00",
			"exchanged_currency": "BRL",
			"exchange": "1.00",
			"fee": "0.02000000"
		}
	}
}
```

{% hint style="warning" %}
**Important**
{% endhint %}

* This payment method is different from the PIX
* PicPay does not have copy and paste
* Need the PicPay app installed
* Use <mark style="color:red;">`payment > url`</mark> to open PicPay checkout

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Peru


# Bank Transfer

Call the Payments API to request payments via Bank Transfer on Peru

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "123456789",
                "type": "DNI"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "PEN",
            "amount": 300,
        },
        "country": "PER",
        "payment_method": "bank_transfer",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., PER). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://payment-stg.tupayonline.com/v1/checkout/SmartFastPay..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "PEN",
            "exchanged_total": 27525.47,
            "exchanged_currency": "PEN",
            "exchange": 1.00,
            "fee": 92.5226
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# CIP

Call the Payments API to request payments via CIP on Peru

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "123456789",
                "type": "DNI"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "PEN",
            "amount": 300,
        },
        "country": "PER",
        "payment_method": "cip",
        "notification_url": "http://mysite.com/api/notification",
        "extra": {
            "bank_code": "1005"
        }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., PER). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>extra.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Some providers require you to provide the bank code. If you need details about the banks, see the bank code list section in the documentation.<br><a href="/pages/UmMaPYISEmpN2Rvqdz6e">List of bank codes.</a></td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "cip",
            "url": "https://payment-stg.tupayonline.com/v1/checkout/SmartFastPay..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "PEN",
            "exchanged_total": 27525.47,
            "exchanged_currency": "PEN",
            "exchange": 1.00,
            "fee": 92.5226
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Wallet

Call the Payments API to request payments via Wallet (QR Code) on Peru

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "123456789",
                "type": "DNI"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "PEN",
            "amount": 300,
        },
        "country": "PER",
        "payment_method": "wallet",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., PER). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "wallet",
            "qr_code": "837495837459827349572345629349y827384979245934030400000001...",
            "url": "https://checkout..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "PEN",
            "exchanged_total": 27525.47,
            "exchanged_currency": "PEN",
            "exchange": 1.00,
            "fee": 92.5226
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Credit Card

Call the Payments API to request payments via Credit Card on Peru

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "123456789",
                "type": "DNI"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "PEN",
            "amount": 300,
        },
        "country": "PER",
        "payment_method": "credit_card",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., PER). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "credit_card",
            "url": "https://payment-stg.tupayonline.com/v1/checkout/SmartFastPay..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "PEN",
            "exchanged_total": 27525.47,
            "exchanged_currency": "PEN",
            "exchange": 1.00,
            "fee": 92.5226
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Equador


# Wallet

Call the Payments API to request payments via Wallet on Equador

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "2234583876",
                "type": "CC"
            },
            "phone": "+5930999000000"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "USD",
            "amount": 7866.75,
        },
        "country": "ECU",
        "payment_method": "wallet",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. <br><br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "wallet",
            "qr_code": "data:/image64",
            "url": "https://pagar.deuna.app/SFP/merchant?id=SMARTFASTPAY"
        },
        "values": {
            "source_total": "7866.75000000",
            "source_currency": "USD",
            "exchanged_total": "7866.75000000",
            "exchanged_currency": "USD",
            "exchange": 1.00,
            "fee": "157.33500000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Cash Payment

Call the Payments API to request payments via Cash Payment on Equador

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "2234583876",
                "type": "CC"
            },
            "phone": "+5930999000000"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "USD",
            "amount": 7866.75,
        },
        "country": "ECU",
        "payment_method": "cash_payment",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. <br><br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "cash_payment",
            "url": "https://checkout.page.com?token=eyJhahsdfjhsdkfjhasdfui"
        },
        "values": {
            "source_total": "7866.75000000",
            "source_currency": "USD",
            "exchanged_total": "7866.75000000",
            "exchanged_currency": "USD",
            "exchange": 1.00,
            "fee": "157.33500000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Bank Transfer

Call the Payments API to request payments via Bank Transfer on Equador

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "2234583876",
                "type": "CC"
            },
            "phone": "+5930999000000"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "USD",
            "amount": 10.00,
        },
        "country": "ECU",
        "payment_method": "bank_transfer",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. <br><br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://sandbox-gateway.safetypay.com/Express4/Checkout/index?TokenID=000&CountryID=ECU&ChannelID=ONLINE"
        },
        "values": {
            "source_total": "10.00000000",
            "source_currency": "USD",
            "exchanged_total": "10.00000000",
            "exchanged_currency": "USD",
            "exchange": 1.00,
            "fee": "1.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Mobile Money

Call the Payments API to request payments via Mobile Money on Equador

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "2234583876",
                "type": "CC"
            },
            "phone": "+5930999000000"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "USD",
            "amount": 10.00,
        },
        "country": "ECU",
        "payment_method": "mobile_money",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. <mark style="color:red;"><strong>This number needs to be registered on the provider.</strong></mark><br><br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "mobile_money"
        },
        "values": {
            "source_total": "10.00000000",
            "source_currency": "USD",
            "exchanged_total": "10.00000000",
            "exchanged_currency": "USD",
            "exchange": 1.00,
            "fee": "1.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Colombia


# PSE by Checkout

Call the Payments API to request payments via PSE on Colombia

***

### <mark style="color:orange;">POST</mark> /v2/transaction/checkout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "2663ded1-874a-480a-8b0e-8f6117415a70",
            "name": "John Doe",
            "email": "john.doe@teste.com",
            "document": {
                "type": "CC",
                "number": "12345678"
            },
            "phone": "+573041093694",
            "address": {
                "address_1": "Dare Groves",
                "address_2": null,
                "number": "130",
                "neighborhood": "Courtney Jacobi",
                "city": "East Savionbury",
                "state": "CUN",
                "postal_code": "757126",
                "country_code": "COL"
            }
        },
        "country": "COL",
        "payment_method": ["pse"],
        "notification_url": "https://annalise.net",
        "transaction": {
            "id": "37e9d594-630c-412c-b8d0-9a7e00cb5b14",
            "currency": "COP",
            "amount": 34.74,
            "redirect_url": "https://www.smartfastpay.com/"
        }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., COP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: COP</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>transaction.redirect_url</code></td><td align="center"><mark style="color:red;">url</mark></td><td align="center">no</td><td>The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>array ["pse"] min:1 | max: 1</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response (URL)**
{% endhint %}

```json
{
	"requestId": "885b5a8b3b6d618fc00af18acfc6398e\/5600721297656558446;o=1",
	"data": {
		"url": "https:\/\/sandbox-checkout.smartfastpay.com\/v1\/67407dc8-594d-4bcd-ba31-asdf\/cHNl\/eyJkb2N1bWVudCI6eyJ0eXBlIjoiQ0MiLCJudW1iZXIiOiIxMjM0NTY3OCJ9LCJwaG9uZSI6Iis1NzMwNTEwMDAwMDIiLCJhZGRyZXNzIjp7ImFkZHJlc3NfMSI6IkRhcmUgR3JvdmVzIiwiYWRkcmVzc18yIjpudWxsLCJudW1iZXIiOiIxMzAiLCJuZWlnaGJvcmhvb2QiOiJDb3VydG5leSBKYWNvYmkiLCJjaXR5IjoiRWFzdCBTYXZpb25idXJ5Iiwic3RhdGUiOiJDVU4iLCJwb3N0YWxfY29kZSI6Ijc1NzEyNiIsImNvdW50cnlfY29kZSI6IkNPTCJ9LCJleHRyYSI6eyJiYW5rX2NvZGUiOiIxMDIy9999",
		"transaction_id": "67407dc8-594d-4bcd-ba31-ab5ff17ddfdd",
		"expires_in": 1727202935
	}
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}

<table><thead><tr><th width="296">Parameter</th><th>Description</th></tr></thead><tbody><tr><td>transaction_<code>id</code></td><td>A unique identifier for the response generated by the payment system, used to track the transaction. Can be used to verify the payment status in the<br><a href="/pages/BPkMmDvgwayJcr02hxZi"> <mark style="color:green;"><strong>GET</strong> /transaction/{id}</mark></a> endpoint</td></tr><tr><td><code>expires_in</code></td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>url</code></td><td>The URL provided to the customer for completing the payment.</td></tr></tbody></table>

{% hint style="info" %}
**Response (HTML)**
{% endhint %}

<div><figure><img src="/files/IoxWjkmDNM6oDScx8R52" alt=""><figcaption></figcaption></figure> <figure><img src="/files/aQM4I3KfpvnuoIXXiIDR" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="/files/HWeUl7CMlxicyoZa3T2B" alt=""><figcaption></figcaption></figure> <figure><img src="/files/qq2mETcVuplYEKFl0Tgi" alt=""><figcaption></figcaption></figure></div>

<div><figure><img src="/files/Xlw4jxeIuRTb4uXNXutV" alt=""><figcaption></figcaption></figure> <figure><img src="/files/U5gBBRPanE6y7TTJNUON" alt=""><figcaption></figcaption></figure> <figure><img src="/files/KgUj24n77Opfvkpy19Y9" alt=""><figcaption></figcaption></figure></div>


# PSE

Call the Payments API to request payments via PSE on Colombia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            },
            "address": "Address from user"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "pse",
        "notification_url": "https://mysite.com/api/notification",
        "extra": {
            "bank_code": "1007"
        }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>extra.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Some providers require you to provide the bank code. If you need details about the banks, see the bank code list section in the documentation.<br><a href="/pages/UmMaPYISEmpN2Rvqdz6e">List of bank codes.</a></td></tr><tr><td><code>customer.address</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The primary street address of the customer</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "pse",
            "url": "https://secure.pse.lat/t/smartfastpay"
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Nequi Push

Call the Payments API to request payments via Nequi on Colombia - Push Notification

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.\
\ <mark style="color:red;">**IMPORTANT:**</mark> <mark style="color:red;"></mark><mark style="color:red;">All NEQUI payments must be paid within a maximum period of 10 minutes, after which the transaction will be cancelled.</mark>

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "nequi",
        "notification_url": "https://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "nequi",
            "url": "https://checkout.smartfastpay.com/v1/4a79f3b4.....",
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Nequi - HPP

Call the Payments API to request payments via Nequi on Colombia - With Redirect Url

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "nequi_v2",
        "notification_url": "https://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "nequi_v2",
            "url": "https://checkout.smartfastpay.com/v1/4a79f3b4.....",
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Bank Transfer

Call the Payments API to request payments via Bancolombia on Colombia - Bank Transfer

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "bancolombia",
        "notification_url": "https://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COP). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bancolombia",
            "url": "https://secure.payzen.lat/t/smartfastpay"
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Transfiya

Call the Payments API to request payments via Transfiya on Colombia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "transfiya",
        "notification_url": "https://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COP). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "transfiya"
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Bre-b

Call the Payments API to request payments via Bre-b on Colombia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "breb",
        "notification_url": "https://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COP). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "breb",
            "qr_code": "VBORw0KGgoAAAANSUhEUgAAAYEAAAGBCAIAAAAPO5pzAABAZklEQVR4Xu3QUW5kybZjwTf4565",
            "qr_url": "https://storage",
            "url": "https://checkout",
            "breb_key": "@"
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}

| Parameter | Type                                            | Description                                                         |
| --------- | ----------------------------------------------- | ------------------------------------------------------------------- |
| qr\_code  | <mark style="color:red;">`string/base64`</mark> | The QR code image is encoded in Base64 format (usually a PNG).      |
| qr\_url   | <mark style="color:red;">`url`</mark>           | The direct (public) link where the QR Code image.                   |
| breb\_key | <mark style="color:red;">`string`</mark>        | The Breb key (alias) of the receiving account in the Breb system.   |
| url       | <mark style="color:red;">`url`</mark>           | The link to the checkout page or the deep link for the transaction. |


# Efecty

Call the Payments API to request payments via Efecty on Colombia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "phone": "+573041093694",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "efecty",
        "notification_url": "https://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COP). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "efecty",
            "url": "https:\/\/secure.payty.com"
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Chile


# Bank Transfer

Call the Payments API to request payments via Bank Transfer on Chile

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "18667538",
                "type": "CI"
            },
            "phone": "+56956249181"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "CLP",
            "amount": 2200,
        },
        "country": "CHL",
        "payment_method": "bank_transfer",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., CLP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., CHL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://pmt-sandbox.etpay.com/session/00tDcL5YY1BNPEYkv..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "CLP",
            "exchanged_total": 27525.47,
            "exchanged_currency": "CLP",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Wallet

Call the Payments API to request payments via Wallet on Chile

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "18667538",
                "type": "CI"
            },
            "phone": "+56956249181"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "CLP",
            "amount": 2200,
        },
        "country": "CHL",
        "payment_method": "wallet",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., CLP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., CHL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://des.payku.cl/gateway/cobro?id=trx40a3ddf728..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "CLP",
            "exchanged_total": 27525.47,
            "exchanged_currency": "CLP",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Cash Payment

Call the Payments API to request payments via Cash on Chile

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "18667538",
                "type": "CI"
            },
            "phone": "+56956249181"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "CLP",
            "amount": 2200,
        },
        "country": "CHL",
        "payment_method": "cash_payment",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., CLP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., CHL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "cash_payment",
            "url": "https://des.payku.cl/gateway/cobro?id=trx40a3ddf728..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "CLP",
            "exchanged_total": 27525.47,
            "exchanged_currency": "CLP",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Credit Card

Call the Payments API to request payments via Credit Card on Chile

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "18667538",
                "type": "CI"
            },
            "phone": "+56956249181"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "CLP",
            "amount": 2200,
        },
        "country": "CHL",
        "payment_method": "credit_card",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., CLP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., CHL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://des.payku.cl/gateway/cobro?id=trxc8a0b60a7..."
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "CLP",
            "exchanged_total": 27525.47,
            "exchanged_currency": "CLP",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Bolivia


# Wallet

Call the Payments API to request payments via Wallet on Bolivia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "8952413",
                "type": "CI"
            },
            "phone": "+59167745950"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "BOB",
            "amount": 10,
        },
        "country": "BOL",
        "payment_method": "wallet",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>E.164</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. <br><br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BOB). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BOL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "wallet",
            "qr_code": null,
            "qr_url": "https://storage/qrcode_link"
        },
        "values": {
            "source_total": 10.00,
            "source_currency": "BOB",
            "exchanged_total": 10.00,
            "exchanged_currency": "BOB",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Tigo Money

Call the Payments API to request payments via Tigo Money on Bolivia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "8952413",
                "type": "CI"
            },
            "phone": "+59167745950"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "BOB",
            "amount": 10,
        },
        "country": "BOL",
        "payment_method": "tigo_money",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "tigo_money"
        },
        "values": {
            "source_total": 10.00,
            "source_currency": "BOB",
            "exchanged_total": 10.00,
            "exchanged_currency": "BOB",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# México


# Bank Transfer

Call the Payments API to request payments via Bank Transfer on México - SPEI

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "RICJ750331HDFVMN04",
                "type": "CURP"
            },
            "phone": "+56956249181"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "MXN",
            "amount": 2200,
        },
        "country": "MEX",
        "payment_method": "bank_transfer",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., MXN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., MEX). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>extra.payment_flow</code></td><td align="center"><mark style="color:red;"><code>string</code> (h2h)</mark></td><td align="center">no</td><td>Defines whether transfer data should be included in the response. Use <mark style="color:red;"><strong>'h2h'</strong></mark> to receive detailed transfer information.</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://pmt-sandbox.com/session/00tDcL5YY1BNPEYkv...",
            "payment_description": "Payment to description",
            "account_number": "545646546546",
            "beneficiary": "beneficiary",
            "reference_numerical": "0000002"
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "MXN",
            "exchanged_total": 27525.47,
            "exchanged_currency": "MXN",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Wallet

Call the Payments API to request payments via Wallet on México - CoDi

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "RICJ750331HDFVMN04",
                "type": "CURP"
            },
            "phone": "+56956249181"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "MXN",
            "amount": 2200,
        },
        "country": "MEX",
        "payment_method": "wallet",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., MXN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., MEX). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "wallet",
            "qr_code": "data:image\/png;base64,iVBORw0KGgoAAAANSUhE",
            "qr_url": "https://storage/qrcode_link"
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "MXN",
            "exchanged_total": 27525.47,
            "exchanged_currency": "MXN",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Argentina


# Bank Transfer

Call the Payments API to request payments via Bank Transfer on Argentina

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "12345678909",
                "type": "DNI"
            },
            "phone": "+5491112345678"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "ARS",
            "amount": 2200,
        },
        "country": "ARG",
        "payment_method": "bank_transfer",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., ARS). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ARG). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://engine.provider.com/payment...",
            "operationId": "1752858000000",
            "accountNumber": "0000003100039000000000",
            "bankName": "NameOfBank",
            "beneficiaryName": "NameOfBeneficiary"
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "ARS",
            "exchanged_total": 27525.47,
            "exchanged_currency": "ARS",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Wallet QR

Call the Payments API to request payments via Wallet QR on Argentina

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "12345678909",
                "type": "DNI"
            },
            "phone": "+5491112345678"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "ARS",
            "amount": 2200,
        },
        "country": "ARG",
        "payment_method": "wallet",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., ARS). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ARG). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "wallet",
            "url": "https://engine.provider.com/payment...",
            "qr_code": "https://ji7iucah1obe",
            "qr_url": "https://ji7iucah1obe"
        },
        "values": {
            "source_total": 27525.47,
            "source_currency": "ARS",
            "exchanged_total": 27525.47,
            "exchanged_currency": "ARS",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# Uruguay


# Cash Payment

Call the Payments API to request payments via Cash on Uruguay

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.\
\ <mark style="color:red;">**Pay attention to the customer details, as the address is required.**</mark>

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "123456789",
                "type": "CI"
            },
            "phone": "+59891016701",
            "address": {
		            "address_1": "address_1",
            		"city": "city",
            		"state": "state"
        	  }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "UYU",
            "amount": 200.00,
        },
        "country": "URY",
        "payment_method": "cash_payment",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The primary street address of the customer</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The state or region of the customer's address</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., UYU). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ARG). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "bank_transfer",
            "url": "https://engine.provider.com/payment..."
        },
        "values": {
            "source_total": "200.00000000",
            "source_currency": "UYU",
            "exchanged_total": "200.00",
            "exchanged_currency": "UYU",
            "exchange": "1.00",
            "fee": "2.00000000"
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# ASIA


# India


# UPI

Call the Payments API to request payments via UPI on India

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the [**Overview**](/methods-and-markets/payin/overview) page, where you'll find all the foundational elements that apply across different countries and methods.

### <mark style="color:orange;">POST</mark> /v2/payin

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "richard@roe.com",
            "document": {
                "number": "BNZAA2318J",
                "type": "ID"
            },
            "phone": "+911234567821"
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "INR",
            "amount": 10.00,
        },
        "country": "IND",
        "payment_method": "upi",
        "notification_url": "http://mysite.com/api/notification"
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="291">Parameter</th><th width="120" align="center">Type</th><th width="102" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., IRN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., IND). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as upi...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>redirect_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page</td></tr></tbody></table>

{% hint style="info" %}
**Response**&#x20;
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "upi",
            "qr_code": "upi://pay?",
            "url": "https:\/\/aaaaaa.bbbbbbbbbb.com\/000000\/d3R4YkVtQ25LaF..."
        },
        "values": {
            "source_total": 10.00,
            "source_currency": "INR",
            "exchanged_total": 10.00,
            "exchanged_currency": "INR",
            "exchange": 1.00,
            "fee": 0
        }
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payin/overview)
{% endhint %}


# PayOut


# Overview

Call the Payouts API to request host-to-host payout methods.

The API parameters are organized into distinct objects to streamline the payout process and ensure clarity in data handling. Each object represents a specific aspect of the transaction, making it easier to manage and understand the flow of information. However, some parameters stand alone and are not part of any object. Below is an overview of the objects and their corresponding parameters, as well as the standalone parameters:

* **Customer**: Represents the individual making the payout. This object includes critical information about the customer, such as their unique ID, name, email address, and optionally, their IP address and birthdate. The **customer.document** sub-object details the type and number of the customer's official identification, while the **customer.address** sub-object includes the customer's full address, which may be required depending on the payout method.
* **Transaction**: This object contains all the essential details about the transaction itself, including a unique transaction ID, the currency used, the total amount involved, and optionally, the time until the transaction expires.
* **Payment**: Represents the payout method and related URLs for completing the transaction. This object is crucial for determining how the customer will pay and where they will be redirected after the payout is completed.
* **Values**: This object provides detailed financial information related to the transaction. It includes the original and converted amounts, the currencies involved, the exchange rate applied, and any fees associated with the transaction.

Standalone parameters, such as **branch**, **country**, **notification\_url**, and **redirect\_url**, do not belong to any specific object. These parameters provide additional information relevant to the transaction, such as the location of the transaction, the country code, where payout notifications should be sent, and where the customer should be redirected after completing the payout.

Our API structure remains consistent across different payout methods and countries, making it easy to adapt as you expand into new regions or integrate new methods.

{% hint style="info" %}
**Knowing the parameters used**
{% endhint %}

<table><thead><tr><th width="346">Parameter</th><th width="120" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The full name of the customer making the payout. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The email address of the customer. This will be used for sending payout confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payout method used</td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payout method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payout process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a>.</td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>redirect_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>The URL to which the customer will be redirected after completing the payment. This parameter is optional and typically used for providing a success or failure page</td></tr></tbody></table>

{% hint style="info" %}
**Example response for a bank\_transfer payout method request**
{% endhint %}

{% tabs %}
{% tab title="success" %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "PEN",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "PEN",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% endtab %}

{% tab title="error" %}

```json
{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="296">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>A unique identifier for the response generated by the payment system, used to track the transaction. Can be used to verify the payment status in the<br> <a href="/pages/vEqAgNjmDsDWYOmeFOnX#get-payout-id"><mark style="color:green;"><strong>GET</strong> /payout/{id}</mark></a> endpoint</td></tr><tr><td><code>status</code></td><td>The current status of the transaction such as <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>onhold</code></mark>, <mark style="color:red;"><code>success, refunded</code></mark>, <mark style="color:red;"><code>failed</code></mark></td></tr><tr><td><code>payment.method</code></td><td>The payment method that was used for the transaction, such as <mark style="color:red;"><code>bank_transfer</code></mark>, <mark style="color:red;"><code>pix</code></mark>...</td></tr><tr><td><code>values.source_total</code></td><td>The total amount of the transaction in the source currency before any exchange</td></tr><tr><td><code>values.source_currency</code></td><td>The original currency of the transaction as specified in the request</td></tr><tr><td><code>values.exchanged_total</code></td><td>The total amount of the transaction after currency conversion, if applicable</td></tr><tr><td><code>values.exchanged_currency</code></td><td>The currency in which the payment was completed after conversion</td></tr><tr><td><code>values.exchange</code></td><td>The exchange rate applied to convert the source currency to the target currency</td></tr><tr><td><code>values.fee</code></td><td>The amount charged by our service for processing the transaction</td></tr></tbody></table>

***

Our API is **designed to be flexible and adaptable**, so as you expand into new regions or add more payment methods, you can easily apply these principles across different implementations.

If you need further details on other payment methods or countries, be sure to explore the rest of our documentation. Additionally, we have a **dedicated FAQ and support section** to help with common questions:

{% content-ref url="/pages/sG2x9TC0UHqtsQdZkvWZ" %}
[FAQ & Support](/resources/faq-and-support)
{% endcontent-ref %}


# LATAM


# Brazil


# PIX

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CPF",
          "number": "12345678909"
        }
      },
      "country": "BRA",
      "payment_method": "pix",
      "notification_url": "http://mysite.com/api/notification",
      "transfer": {
        "value": "12345678909"
      },
      "transaction": {
        "id": "4ff7f67f-8194-4a66-903f-0600716f27e8",
        "currency": "BRL",
        "amount": 100
      }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CPF or CNPJ)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CPF</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(BRL or USD)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: BRL</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>transfer.value</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Pix key</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "pix"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "BRL",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "BRL",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813dda",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CPF",
          "number": "12345678909"
        }
      },
      "country": "BRA",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_agency": "0000",
        "bank_code": "0000",
        "bank_account_number": "0000000-5",
        "bank_account_type": "SAVINGS",
        "bank_name": "Nu Pagamentos S.A"
      },
      "transaction": {
        "id": "9eb8f27c-3430-4529-83ec-21bbe438f8ae",
        "currency": "BRL",
        "amount": 200
      }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="242">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CPF or CNPJ)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CPF</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(BRL or USD)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BRL, USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: BRL</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_agency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Agency</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr><tr><td><code>bank_transfer.bank_name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Name</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "BRL",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "BRL",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Colombia


# Transfiya

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CC",
          "number": "1073505526"
        },
        "phone": "+573041093694"
      },
      "country": "COL",
      "payment_method": "transfiya",
      "notification_url": "http://mysite.com/api/notification",
      "transfer": {
        "value": "573041093694"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "COP",
        "amount": 2000
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., COP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>transfer.value</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Phone - Only numbers</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "transfiya"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "COP",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "COP",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Bre-b

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CC",
          "number": "1073505526"
        },
        "phone": "+573041093694"
      },
      "country": "COL",
      "payment_method": "breb",
      "notification_url": "http://mysite.com/api/notification",
      "transfer": {
        "value": "579889952105"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "COP",
        "amount": 2000
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="266">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., COP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>transfer.value</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Key Bre-b</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "breb"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "COP",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "COP",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CC",
          "number": "1073505526"
        },
        "phone": "+573041093694"
      },
      "country": "COL",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "1007",
        "bank_account_number": "04800001840",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "COP",
        "amount": 2000
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="302">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(CC or CE)</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.<br><strong>Default: CC</strong></td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(COP)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., COP). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a><br><strong>Default: COP</strong></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., COL for Colômbia). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING or ELETRONIC_DEPOSIT)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type<br><mark style="color:red;"><strong><code>(SAVINGS or CHECKING or ELETRONIC_DEPOSIT)</code></strong></mark></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "COP",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "COP",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Peru


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "DNI",
          "number": "12345678"
        },
        "phone": "+5564981038038"
      },
      "country": "PER",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "002",
        "bank_account_number": "01135400010004648881",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "PEN",
        "amount": 2000
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="305">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., PER). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number / CCI</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "PEN",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "PEN",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Ecuador


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "phone": "+5930999000000",
        "document": {
          "type": "CC",
          "number": "2234583876"
        }
      },
      "country": "ECU",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "0010",
        "bank_account_number": "7884321419",
        "bank_account_type": "CHECKING"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "USD",
        "amount": 10.67
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="306">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "USD",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "USD",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Mobile Money

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "phone": "+5930999000000",
        "document": {
          "type": "CC",
          "number": "2234583876"
        }
      },
      "country": "ECU",
      "payment_method": "mobile_money",
      "notification_url": "http://mysite.com/api/notification",
      "transfer": {
        "value": "5930999000000"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "USD",
        "amount": 10.67
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="306">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td><p>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used. <mark style="color:red;"><strong>This number needs to be registered on the provider.</strong></mark></p><p><br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></p></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ECU). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>transfer.value</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Phone - Only numbers</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "mobile_money"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "USD",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "USD",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Chile


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "RUT",
          "number": "114741671"
        }
      },
      "country": "CHL",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "001",
        "bank_account_number": "123456789",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "CLP",
        "amount": 2000
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="309">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., CPL). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BRA for Brazil). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "CLP",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "CLP",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# México


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CURP",
          "number": "RICJ750331HDFVMN04"
        }
      },
      "country": "MEX",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "001",
        "bank_account_number": "072180011751301416",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "MXN",
        "amount": 2000
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="309">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(MXN)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., MXN). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., MEX). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "18.00000000",
	    "source_currency": "MXN",
	    "exchanged_total": "18.00",
	    "exchanged_currency": "MXN",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Bolivia


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CI",
          "number": "8952413"
        }
      },
      "country": "BOL",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "1",
        "bank_account_number": "7884321419",
        "bank_account_type": "CHECKING"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "BOB",
        "amount": 10
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="309">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(MXN)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., BOB). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., BOL). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "10.00000000",
	    "source_currency": "BOB",
	    "exchanged_total": "10.00",
	    "exchanged_currency": "BOB",
	    "exchange": "1.00",
	    "fee": "0.10000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Argentina


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "DNI",
          "number": "12345678909"
        }
      },
      "country": "ARG",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "17",
        "bank_account_number": "0140199403506757801875",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "ARS",
        "amount": 10
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="309">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(ARS)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., ARS). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ARG). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "10.00000000",
	    "source_currency": "ARS",
	    "exchanged_total": "10.00",
	    "exchanged_currency": "ARS",
	    "exchange": "1.00",
	    "fee": "0.10000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# Uruguay


# Bank Transfer

Call the Payouts API to request withdrawal for your customer.

***

<mark style="color:red;">**Pay attention to the customer details, as the address is required.**</mark>

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "CI",
          "number": "123456789"
        },
        "address": {
		        "address_1": "address_1",
            "city": "city",
            "state": "state"
         }
      },
      "country": "URY",
      "payment_method": "bank_transfer",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "1001",
        "bank_account_number": "0140199403506757801875",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "UYU",
        "amount": 200.00
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="309">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center">no</td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(ARS)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., ARS). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., ARG). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code</td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number</td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "bank_transfer"
	},
	"values": {
	    "source_total": "10.00000000",
	    "source_currency": "ARS",
	    "exchanged_total": "10.00",
	    "exchanged_currency": "ARS",
	    "exchange": "1.00",
	    "fee": "0.10000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# ASIA


# India


# IMPS

Call the Payouts API to request withdrawal for your customer with IMPS on India

***

### <mark style="color:orange;">POST</mark> /v2/payout

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
      "customer": {
        "id": "b48a0728-9ff4-47ee-8f1b-92d2d5813ddb",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": {
          "type": "ID",
          "number": "BNZAA2318J"
        },
        "phone": "+911234567821",
      },
      "country": "IND",
      "payment_method": "imps",
      "notification_url": "http://mysite.com/api/notification",
      "bank_transfer": {
        "bank_code": "BKID00000000",
        "bank_account_number": "601000000000000",
        "bank_account_type": "SAVINGS"
      },
      "transaction": {
        "id": "73e7036e-b835-4130-8db0-2f82cc859662",
        "currency": "INR",
        "amount": 10.00
      }
    }'
```

{% endcode %}

<table><thead><tr><th width="306">Parameter</th><th width="120" align="center">Type</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>customer.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer</td></tr><tr><td><code>customer.name</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The full name of the customer making the payment. It should match the name on the customer's identification documents</td></tr><tr><td><code>customer.email</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The email address of the customer. This will be used for sending payment confirmations and notifications</td></tr><tr><td><code>customer.phone</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(E.164)</code></mark></td><td align="center"><strong>yes</strong></td><td>The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used.<br><a href="https://www.twilio.com/docs/glossary/what-e164">https://www.twilio.com/docs/glossary/what-e164</a></td></tr><tr><td><code>customer.birthdate</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The birthdate of the customer, provided in the format <code>mm-dd-yyyy</code>. This parameter may be required depending on the country regulations or the payment method</td></tr><tr><td><code>customer.document.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999 / 9999999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>The official identification number of the customer. This is typically a national ID, or other government-issued document</td></tr><tr><td><code>customer.document.type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The type of document provided by the customer. Common types include national ID, or driver's license. <a href="/pages/yXqITA9HFiwkUhEhGFNm">List of documents allowed</a>.</td></tr><tr><td><code>customer.address.addres_1</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The primary street address of the customer </td></tr><tr><td><code>customer.address.addres_2</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>Additional address information, such as apartment number or suite</td></tr><tr><td><code>customer.address.city</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The city in which the customer resides</td></tr><tr><td><code>customer.address.country_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The ISO 3166-1 alpha-3 country code for the customer's address. <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>customer.address.neightborhood</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The neighborhood or district of the customer's address</td></tr><tr><td><code>customer.address.number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The street number of the address</td></tr><tr><td><code>customer.address.postal_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The postal or ZIP code for the customer's address</td></tr><tr><td><code>customer.address.state</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center">no</td><td>The state or region of the customer's address </td></tr><tr><td><code>transaction.id</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process</td></tr><tr><td><code>transaction.currency</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(INR)</code></mark></td><td align="center"><strong>yes</strong></td><td>The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., INR). <a href="/pages/AV8tyVPt6rJX0yyuYIej">List of currency codes</a></td></tr><tr><td><code>transaction.amount</code></td><td align="center"><mark style="color:red;"><code>decimal</code></mark><br><mark style="color:red;"><code>(10,2)</code></mark></td><td align="center"><strong>yes</strong></td><td>The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><code>transaction.expire</code></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>The time in seconds until the transaction expires and is no longer valid</td></tr><tr><td><code>branch</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>The specific branch or location identifier where the transaction is being processed, if applicable</td></tr><tr><td><code>country</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The country code where the transaction is taking place. The format is <code>ISO 3166-1 alpha-3</code> (e.g., IND). <a href="/pages/WEBQfG9FyAw1HF4fdryA">List of country codes.</a></td></tr><tr><td><code>payment_method</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The method of payment being used for the transaction, such as bank transfer, credit card...</td></tr><tr><td><code>notification_url</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format</td></tr><tr><td><code>bank_transfer.bank_code</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Code<br>ex. <mark style="color:red;">BKID00000000</mark></td></tr><tr><td><code>bank_transfer.bank_account_number</code></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Number<br>ex. <mark style="color:red;">601000000000000</mark></td></tr><tr><td><code>bank_transfer.bank_account_type</code></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(SAVINGS or CHECKING)</code></mark></td><td align="center"><strong>yes</strong></td><td>Bank Account Type</td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "de3af972e3cea7d6cd998bc4761f05f4\/15349144900800090226",
    "data": {
	"id": "2d6c4f53-8ec4-4cfc-82b7-df1bde11bf92",
	"status": "pending",
	"payment": {
	    "method": "imps"
	},
	"values": {
	    "source_total": "10.00000000",
	    "source_currency": "INR",
	    "exchanged_total": "10.00",
	    "exchanged_currency": "INR",
	    "exchange": "1.00",
	    "fee": "0.18000000"
	}
    }
}
```

{% hint style="info" %}
**Response details following the link:** [**overview**](/methods-and-markets/payout/overview)
{% endhint %}


# FAQ & Support


# How to get the token

Your access token authorizes you to use the SmartFastPay REST API server. To call a REST API in your integration, exchange your client ID and secret for an access token in an OAuth 2.0 token call.

***

While there are a few ways to get a token, here are examples using both the [Postman app](#postman) and a [cURL](#curl) command.

Your own environment's HTTP library or function may have <mark style="color:red;">`username`</mark> and <mark style="color:red;">`password`</mark> fields or an auth parameter in which you pass your client ID and secret. You can also add your Base64 encoded client ID and secret in an <mark style="color:red;">`Authorization: Basic`</mark> header.

***

### Postman

To generate REST API credentials for the sandbox and live environments:

1. Download [Postman](https://www.postman.com/downloads/) for your environment.
2. In Postman, select the <mark style="color:red;">`POST`</mark> method.
3. Enter the <mark style="color:red;">`https://sandbox.smartfastpay.com/oauth2/token`</mark> request URL.
4. On the **Authorization** tab, select the **Basic Auth** type.\
   Type your client ID in the **Username** box, and type your secret in the **Password** box.
5. Click **Send**.

In exchange for these credentials, the SmartFastPay authorization server returns your access token in the access\_token field:

{% hint style="info" %}
**Response**
{% endhint %}

```bash
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "access_token": "<Access-Token>",
        "token_type": "Bearer",
        "expires_in": 3600
    }
}
```

Include this bearer token in the Authorization header with the Bearer authentication scheme in REST API calls to prove your identity and access protected resources. This sample request includes a bearer token:

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/transaction/checkout' \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer <Access-Token>"
```

Access tokens have a finite lifetime. The <mark style="color:red;">`expires_in`</mark> field contains the number of seconds after which the token expires. For example, an access token with an expiry value of <mark style="color:red;">`3600`</mark> expires in one hour from when the response was generated. In general, access tokens have a life of 15 minutes or eight hours depending on the scopes associated.

To detect when an access token expires, write code to either:

* Keep track of the <mark style="color:red;">`expires_in`</mark> value in the token response.
* Handle the HTTP <mark style="color:red;">`401 Unauthorized`</mark> status code. The API endpoint issues this status code when it detects an expired token.

Re-use the access token until it expires. Then, get a new token.<br>

***

### cURL

1. Download [cURL](https://curl.haxx.se/download.html) for your enviroment.

> **Note:** On Windows, use a Bash shell to make cURL calls.

2. Run this command, where <mark style="color:red;">`client_id`</mark> is your client ID and <mark style="color:red;">`secret`</mark> is your secret:

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/oauth2/token' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic <Access-Credentials>'
```

> **Note:** If you use a command-line tool other than cURL, set the <mark style="color:red;">`Accept`</mark> header to <mark style="color:red;">`application/x-www-form-urlencoded.`</mark>

In exchange for these credentials, the SmartFastPay authorization server returns your access token in the `access_token` field:

```bash
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "access_token": "<Access-Token>",
        "token_type": "Bearer",
        "expires_in": 3600
    }
}
```

Include this bearer token in the <mark style="color:red;">`Authorization`</mark> header with the <mark style="color:red;">`Bearer`</mark> authentication scheme in REST API calls to prove your identity and access protected resources. This sample request includes a bearer token:

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/transactions/' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer <Access-Token>"
```

Access tokens have a finite lifetime. The <mark style="color:red;">`expires_in`</mark> field contains the number of seconds after which the token expires. For example, an access token with an expiry value of <mark style="color:red;">`3600`</mark> expires in one hour from when the response was generated. In general, access tokens have a life of 15 minutes or eight hours depending on the scopes associated.

To detect when an access token expires, write code to either:

* Keep track of the <mark style="color:red;">`expires_in`</mark> value in the token response.
* Handle the HTTP <mark style="color:red;">`401 Unauthorized`</mark> status code. The API endpoint issues this status code when it detects an expired token.

Re-use the access token until it expires. Then, get a new token.


# Tests to validate your integration

[You can check our transactions status here](/thesmartway/api-requests/status-flow)

This documentation page outlines the testing process for **payment** and **payout** integrations.

The purpose of this testing is to ensure that the integration runs smoothly and without any issues.<br>

Through a series of test scenarios, including **changes** in payment and payout statuses, we verify that the integration is functioning correctly and that all transactions are properly processed.

This testing is an **essential step** in ensuring the **reliability** and **effectiveness** of the integration.<br>

***

\
We will be testing a total of **6 transactions**, which includes **3 payments** and **3 payouts**.

Our goal is to cover all possible scenarios that could occur in a production environment.

Once we receive the Unique Identifiers (UIDs) for these transactions, we will proceed with changing their status to simulate various scenarios.

During this testing process, we will walk through each scenario step-by-step, explaining them in detail as needed, before moving on to the next one.

> If any of the test flow test cases fail, we will **halt the testing process** until the issue is resolved.
>
> This is to ensure that any further tests will not be impacted by the issue, and that we can maintain the reliability and consistency of the integration. Our goal is to deliver a high-quality integration.

***

## Payment Flow Validation

\
We perform 3 tests to cover different payment scenarios

### Test 1: Change status from `pending` to `paid`

<figure><img src="https://docs.smartfastpay.com/assets/images/payment-test1.png" alt=""><figcaption></figcaption></figure>

### Test 2: Change status from `pending` to `expired`

<figure><img src="https://docs.smartfastpay.com/assets/images/payment-test2.png" alt=""><figcaption></figcaption></figure>

### Test 3: Change status from `pending` to `denied`

<figure><img src="https://docs.smartfastpay.com/assets/images/payment-test3.png" alt=""><figcaption></figcaption></figure>

***

## Payout Flow Validation

We perform 4 tests to cover different payout scenarios.

### Test 1: Change status from `pending` to `onhold` (2 transactions)

We require two transactions with the <mark style="color:red;">`onhold`</mark> status for payouts: one for use in **Test 2** and the other for **Test 3**.

<figure><img src="https://docs.smartfastpay.com/assets/images/payout-test1.png" alt=""><figcaption></figcaption></figure>

### Test 2: Change status from `onhold` to `success`

<figure><img src="https://docs.smartfastpay.com/assets/images/payout-test2.png" alt=""><figcaption></figcaption></figure>

### Test 3: Change status from `onhold` to `failed`

<figure><img src="https://docs.smartfastpay.com/assets/images/payout-test3.png" alt=""><figcaption></figcaption></figure>

### Test 4: Change status of a `success` transaction to `refunded`

> This scenario happens when the **customer** or the **bank entity** refunds the amount to **our bank account** for some reason.<br>
>
> In this case, the amount **must be returned** to the customer.
>
> \
> When this happens, our suggestion is to refund the customer through **your platform** so that they can make a new payout request.

<figure><img src="https://docs.smartfastpay.com/assets/images/payout-test4.png" alt=""><figcaption></figcaption></figure>


# Overview

Before integrating a SmartFastPay product or solution, you must set up your development environment to get OAuth 2.0 Client ID and Secret credentials for the sandbox and live environments.

You exchange these credentials for an access token that authorizes your REST API calls. To test your web and mobile apps, you create sandbox accounts

Logging into the [Smart Platform](https://app.smartfastpay.com) to get credentials and create sandbox accounts requires a developer, support, or admin account. Each account provides different levels of access to API functionality.

<table><thead><tr><th width="251">Capabilities</th><th width="179" align="center">Developer Account</th><th width="167" align="center">Support Account</th><th align="center">Admin Account</th></tr></thead><tbody><tr><td>Access Smart Platform</td><td align="center"><strong>x</strong></td><td align="center"><strong>x</strong></td><td align="center"><strong>x</strong></td></tr><tr><td>Customize Payment Page</td><td align="center"><strong>x</strong></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Create New Users</td><td align="center"></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Create Credentials</td><td align="center"></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Manage Transactions (Just on Sandbox Env.)</td><td align="center"><strong>x</strong></td><td align="center"></td><td align="center"><strong>x</strong></td></tr><tr><td>Generate Reports</td><td align="center"></td><td align="center"><strong>x</strong></td><td align="center"><strong>x</strong></td></tr></tbody></table>

***

### Get credentials

To generate REST API credentials for the sandbox and live environments:

1. Log in to the Smart Platform with your account.
2. Under the **MANAGEMENT** menu, select **Credentials**.
3. Remember to write down the chosen client\_secret, once saved, there is no way to recover it, you will need to create a new one.

***

### Get an access token

Your access token authorizes you to use the SmartFastPay REST API server. To call a REST API in your integration, exchange your client ID and secret for an access token in an OAuth 2.0 token call. While there are a few ways to get a token, here are examples using both the Postman app and a cURL command.

Your own environment's HTTP library or function may have <mark style="color:red;">`username`</mark> and <mark style="color:red;">`password`</mark> fields or an `auth` parameter in which you pass your client ID and secret. You can also add your Base64 encoded client ID and secret in an <mark style="color:red;">`Authorization: Basic`</mark> header.<br>

***

### Make REST API calls

In REST API calls, include the URL to the API service for the environment:

* Sandbox: <mark style="color:red;">`https://sandbox.smartfastpay.com`</mark>
* Live: <mark style="color:red;">`https://api.smartfastpay.com`</mark>

Also, include your access token to prove your identity and access protected resources.

This sample call, which shows the Transaction creates, includes a bearer token in the Authorization request header. This type of token lets you complete an action on behalf of a resource owner.

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/transaction/checkout' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "branch": "Office 2",
        "name": "Richard Roe",
        "amount": 4300,
        "currency": "USD",
        "callback": "http://mysite.com/api/notification",
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "redirect": {
                "url": "http://mysite.com/success_payment",
                "type": "URL"
            }
        }
    }'
```

The response shows the page or url, choosed by redirect type:

```json
{
    "requestId": "73eaaecf-1bf4-4847-b4a9-8c615e891e1b",
    "data": {
        "url": "https://sandbox.smartfastpay.com/checkout/v1/f834fc1b-c8a0-4613-bcc9-2c188f6ef180",
        "transaction_id": "f834fc1b-c8a0-4613-bcc9-2c188f6ef180"
    }
}
```


# API Requests

To make a REST API request, you combine the HTTP GET, POST, PUT, PATCH, or DELETE method, the URL to the API service, the URI to a resource to query, submit data to, update, or delete, and one or more

The URL to the API service is either:

* Sandbox: <mark style="color:red;">`https://sandbox.smartfastpay.com`</mark>
* Live: <mark style="color:red;">`https://api.smartfastpay.com`</mark>

Optionally, you can include query parameters on GET calls to filter, limit the size of, and sort the data in the responses.

Most <mark style="color:red;">`GET`</mark>, <mark style="color:red;">`POST`</mark>, <mark style="color:red;">`PUT`</mark>, and <mark style="color:red;">`PATCH`</mark> calls require a JSON request body.

This sample request lists transactions:

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/transactions' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer <Access-Token>"
```

***

### Query parameters

For most REST <mark style="color:red;">`GET`</mark> calls, you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response. For filter parameters, see the individual <mark style="color:red;">`GET`</mark> calls.

To limit, or page, and sort the data that is returned in some API responses, use these, or similar, query parameters:<br>

> **Note:** Not all pagination parameters are available for all APIs.

<table><thead><tr><th width="193">Parameter</th><th width="209">Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>limit</code></mark></td><td><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 40</code></mark></td><td>The number of items to return in the response.</td></tr><tr><td><mark style="color:red;"><code>page</code></mark></td><td><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 9999999</code></mark></td><td>The page number indicates which set of items will be returned in the response. So, the combination of <mark style="color:red;"><code>page=1</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns the first 20 items. The combination of <mark style="color:red;"><code>page=2</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns items 21 through 40.</td></tr><tr><td><mark style="color:red;"><code>sort</code></mark></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: item,(asc|desc)</code></mark></td><td>Sorts the items in the response by filter in ascending or descending order.<br>Eg.: <mark style="color:red;"><code>sort=id,desc</code></mark><br><em>(This combination returns a list in descending order based on id.)</em></td></tr><tr><td><mark style="color:red;"><code>start_time</code></mark></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The start date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>start_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>end_time</code></mark></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The end date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>end_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td>Sorts the items in the response by looking for the customer_id that was once provided by your system.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td><mark style="color:red;"><code>string</code></mark></td><td>Sorts the items in the response by looking for the transaction_id that was once provided by your system.<br>To get multiple transaction_id, send each transaction_id separating by comma (,).<br>Eg.: <mark style="color:red;"><code>8fecdfcc-4e4d-11ee,8fece5ee-4e4d-11ee,d42953be-4e4d-11ee</code></mark></td></tr></tbody></table>

For example, the Transaction API returns details for ten transactions starting with the second page sorted by descending id in the response:

{% code overflow="wrap" fullWidth="false" %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/transactions?limit=10&page=2&sort=id,desc' \
        --header "Content-Type: application/json" \
        --header "Authorization: Bearer < Access-Token >"
```

{% endcode %}

***

### HTTP request headers

The commonly used HTTP request headers are:

{% hint style="info" %}
**Content-Type**
{% endhint %}

The response format, which is required for operations with a response body. The syntax is:

```graphql
Content-Type: application/format
```

Where <mark style="color:red;">`format`</mark> is <mark style="color:red;">`json`</mark>.

{% hint style="info" %}
**Authorization**
{% endhint %}

Required to get an access token or make API calls:

* **Get an access token**

  When you create a sandbox or live REST API app, SmartFastPay generates a set of OAuth 2.0 client ID and secret credentials for the sandbox or live environment. When you make a [get an access token](/v1/guides/authentication) call, set the <mark style="color:red;">`Authorization`</mark> header to these credentials for the environment in which you're making the call.

  In exchange for these credentials, the SmartFastPay authorization server issues a *bearer* access token that you use for authorization when you make REST API requests.

  A bearer token enables you to complete actions on behalf and with the approval of the resource owner.
* **Make REST API calls**

  Include the access token in the <mark style="color:red;">`Authorization`</mark> header with the <mark style="color:red;">`Bearer`</mark> authentication scheme:

  ```graphql
  Authorization: Bearer <Access-Token>
  ```


# Payments

Call the Payments API to request payments via Bank Transfer or PIX.

***

### <mark style="color:orange;">POST</mark> /v1/payment

{% hint style="info" %}
**Request**
{% endhint %}

{% code overflow="wrap" %}

```bash
curl -v --location --request POST 'https://sandbox.smartfastpay.com/v1/payment' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "name": "Richard Roe",
        "email": "richard@roe.com",
        "document": "16972691419",
        "amount": 300,
        "currency": "USD",
        "payment_method": "bank_transfer",
        "callback": "http://mysite.com/api/notification",
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277"
        }
    }'
```

{% endcode %}

{% hint style="info" %}
**Parameters details**
{% endhint %}

<table><thead><tr><th width="193">Parameter</th><th width="196" align="center">Type</th><th width="100" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>branch</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center">no</td><td>When the merchant needs to keep track of its various offices / branch, this field must be fill.</td></tr><tr><td><mark style="color:red;"><code>name</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 3 | max: 150</code></mark></td><td align="center"><strong>yes</strong></td><td>Name of the customer who started the transaction.</td></tr><tr><td><mark style="color:red;"><code>email</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>Email of the customer who started the transaction.</td></tr><tr><td><mark style="color:red;"><code>document</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: 99999999999</code></mark></td><td align="center"><strong>yes</strong></td><td>Brazilian document (CPF) of the customer who started the transaction.<br>- Must be a valid CPF document;<br><mark style="color:red;"><code>Eg: 12345678909</code></mark></td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td align="center"><mark style="color:red;"><code>decimal (10,2)</code></mark><br><mark style="color:red;"><code>min: 2</code></mark></td><td align="center"><strong>yes</strong></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)<br><mark style="color:red;"><code>Eg: 300.10</code></mark></td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td align="center"><mark style="color:red;"><code>string (3)</code></mark><br><mark style="color:red;"><code>(USD or BRL)</code></mark><br><mark style="color:red;"><code>min: 3 | max: 3</code></mark></td><td align="center">no</td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.<br><br>This parameter is optional, if currency isn't provided it will auto-select USD.<br><strong>Default: USD</strong></td></tr><tr><td><mark style="color:red;"><code>payment_method</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>(bank_transfer or pix)</code></mark><br><mark style="color:red;"><code>min: 3 | max: 13</code></mark></td><td align="center"><strong>yes</strong></td><td>The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.</td></tr><tr><td><mark style="color:red;"><code>callback</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 30 | max: 250</code></mark><br><mark style="color:red;"><code>(Method: POST)</code></mark></td><td align="center"><strong>yes</strong></td><td>The URL in you site that our API will notify when the payment changes the status, the HTTP supported method should be HTTP<br><mark style="color:red;"><code>Eg: http://my-url-callback/</code></mark></td></tr><tr><td><mark style="color:red;"><code>transaction</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td align="center"><strong>yes</strong></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>pix</code></mark></td><td align="center"></td><td align="center"></td><td></td></tr><tr><td><mark style="color:red;"><code>expire_in</code></mark></td><td align="center"><mark style="color:red;"><code>integer (11)</code></mark></td><td align="center">no</td><td>Lifetime of the charge, specified in seconds from the creation date, so that the charge payment can be made. If not informed, the duration is assumed to be 1800 seconds, which corresponds to 30 minutes.</td></tr></tbody></table>

{% hint style="info" %}
**Response (PIX)**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "payment": {
            "method": "pix"
        },
        "values": {
            "total": "1557.00",
            "subtotal": "1557.00",
            "exchange": "5.19",
            "fee": 0
        },
        "pix": {
            "qrcode": "00020101021226850014br.gov.bcb.pix2563qrcodepix",
            "reference": "00020101021226850014br.gov.bcb.pix2563qrcodepix",
            "beneficiary": "SmartFastPay"
        }
    }
}
```

{% hint style="info" %}
**Response (Bank Transfer)**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "payment": {
            "method": "bank_transfer"
        },
        "values": {
            "total": "1557.00",
            "subtotal": "1557.00",
            "exchange": "5.19",
            "fee": 0
        },
        "bank": {
            "name": "VIACREDI",
            "code": "085",
            "agency": "0101-5",
            "account": "12551163",
            "account_operation": "Conta Corrente",
            "document": "34.911.051/0001-97",
            "beneficiary": "SmartFastPay"
        }
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="223">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made a unique identificator. Can be used to verify the payment status in the<br> <a href="#get-payment-id"><mark style="color:green;"><strong>GET</strong> /v1/payment/{id}</mark></a> endpoint</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td>The payment method chosen.  <mark style="color:red;"><code>bank_transfer</code></mark> or <mark style="color:red;"><code>pix</code></mark></td></tr><tr><td><mark style="color:red;"><code>values</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>total</code></mark></td><td>The full value of the transaction, including service fees. Decimal separator it a dot</td></tr><tr><td><mark style="color:red;"><code>subtotal</code></mark></td><td>The value of the transaction, without service fees. Decimal separator it a dot</td></tr><tr><td><mark style="color:red;"><code>exchange</code></mark></td><td>The exchange rate applied to the current transaction</td></tr><tr><td><mark style="color:red;"><code>fee</code></mark></td><td>The service fee value</td></tr><tr><td><mark style="color:red;"><code>bank</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>name</code></mark></td><td>Name of the bank where the deposit is going to be made</td></tr><tr><td><mark style="color:red;"><code>code</code></mark></td><td>Brazilian code of the bank to which the deposit is going to be directed</td></tr><tr><td><mark style="color:red;"><code>agency</code></mark></td><td>Agency number with verification digit to which the deposit is going to be directed</td></tr><tr><td><mark style="color:red;"><code>account</code></mark></td><td>Account number with verification digit to which the deposit is going to be directed</td></tr><tr><td><mark style="color:red;"><code>account_operation</code></mark></td><td>Either it's a savings account or a current account. <mark style="color:red;"><code>current account</code></mark>, <mark style="color:red;"><code>saving account</code></mark></td></tr><tr><td><mark style="color:red;"><code>document</code></mark></td><td>Either the owner document or the company document for the account to which the deposit is going to be directed</td></tr><tr><td><mark style="color:red;"><code>beneficiary</code></mark></td><td>Name of the owner of the account to which the deposit is going to be direct</td></tr><tr><td><mark style="color:red;"><code>pix</code></mark></td><td></td></tr><tr><td><mark style="color:red;"><code>qrcode</code></mark></td><td>String that contains the information of the qrcode. It is necessary to use some programming resource to convert this text into an image.</td></tr><tr><td><mark style="color:red;"><code>reference</code></mark></td><td>String that contains the information of the copy and paste pix (pix copia e cola).</td></tr><tr><td><mark style="color:red;"><code>beneficiary</code></mark></td><td>Name of the owner of the account to which the deposit is going to be direct</td></tr></tbody></table>

***

### <mark style="color:green;">GET</mark> /v1/payment/{id}

{% hint style="info" %}
**Request**
{% endhint %}

```bash
curl -v --location --request GET 'https://sandbox.smartfastpay.com/v1/payment/{id}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
        "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
        "amount": "300.00",
        "currency": "USD",
        "status": "pending",    
        "method": "bank_transfer",
        "created_at": "2021-11-11T19:08:20.000000Z",
        "updated_at": "2021-11-11T19:08:20.000000Z"
    }
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="202">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>method</code></mark></td><td>The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.</td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>

***

### <mark style="color:green;">GET</mark> /v1/payments

{% hint style="info" %}
**Request**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v1/payments' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

```bash
# With parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v1/payments?limit=1&order=id,desc' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

{% hint style="info" %}
**Parameters detail**
{% endhint %}

```bash
# Without parameters

curl -v --location --request GET 'https://sandbox.smartfastpay.com/v1/payments' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \'
```

<table><thead><tr><th width="192">Parameter</th><th width="269" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>limit</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 40</code></mark></td><td>The number of items to return in the response.</td></tr><tr><td><mark style="color:red;"><code>page</code></mark></td><td align="center"><mark style="color:red;"><code>integer</code></mark><br><mark style="color:red;"><code>min: 1 | max: 9999999</code></mark></td><td>The page number indicating which set of items will be returned in the response. So, the combination of <mark style="color:red;"><code>page=1</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns the first 20 items. The combination of <mark style="color:red;"><code>page=2</code></mark> and <mark style="color:red;"><code>limit=20</code></mark> returns items 21 through 40.</td></tr><tr><td><mark style="color:red;"><code>sort</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Format: item,(asc|desc)</code></mark></td><td>Sorts the items in the response by filter in ascending or descending order.<br>Eg.: <mark style="color:red;"><code>sort=id,desc</code></mark><br><em>(This combination returns a list in descending order based on id.)</em></td></tr><tr><td><mark style="color:red;"><code>start_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The start date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>start_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>end_time</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>Internet date and time format</code></mark></td><td>The end date and time for the range to show in the response, in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">Internet date and time format</a>.<br>Eg.: <mark style="color:red;"><code>end_time=2021-09-05T11:00:00Z</code></mark>.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark><br><mark style="color:red;"><code>min: 1 | max: 255</code></mark></td><td>Sorts the items in the response by looking for the customer_id that was once provided by your system.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td align="center"><mark style="color:red;"><code>string</code></mark></td><td>Sorts the items in the response by looking for the transaction_id that was once provided by your system.<br>To get multiple transaction_id, send each transaction_id separating by comma (,).<br>Eg.: <mark style="color:red;"><code>8fecdfcc-4e4d-11ee</code></mark><code>,</code><mark style="color:red;"><code>8fece5ee-4e4d-11ee</code></mark><code>, </code><mark style="color:red;"><code>d42953be-4e4d-11ee</code></mark></td></tr></tbody></table>

{% hint style="info" %}
**Response**
{% endhint %}

```json
{
    "requestId": "a2435636-5f69-447d-8e22-8382f62ef7dd",
    "data": [
        {
            "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
            "customer_id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "transaction_id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "amount": "300.00",
            "currency": "USD",
            "status": "pending",
            "method": "bank_transfer",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        },
        {
            "id": "3eff3ce4-9666-4b93-8bbc-64887f164622",
            "customer_id": "d9e9557e-11a5-49df-b51b-d513a7f5b348",
            "transaction_id": "22dd9e47-97c7-4982-af50-3d3e0782d054",
            "amount": "980.00",
            "currency": "USD",
            "status": "pending",
            "method": "pix",
            "created_at": "2021-11-11T19:08:20.000000Z",
            "updated_at": "2021-11-11T19:08:20.000000Z"
        }
    ],
    "current_page": 1,
    "last_page": 1,
    "per_page": 10,
    "to": 2,
    "total": 2
}
```

{% hint style="info" %}
**Response details**
{% endhint %}

<table><thead><tr><th width="192">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><code>id</code></mark></td><td>The created payment by the request made unique identificator.</td></tr><tr><td><mark style="color:red;"><code>customer_id</code></mark></td><td>The customer id stored on your platform for future identification.</td></tr><tr><td><mark style="color:red;"><code>transaction_id</code></mark></td><td>The id of the transaction generated in you platform.</td></tr><tr><td><mark style="color:red;"><code>amount</code></mark></td><td>The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)</td></tr><tr><td><mark style="color:red;"><code>currency</code></mark></td><td>The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.</td></tr><tr><td><mark style="color:red;"><code>status</code></mark></td><td>The current status of the payment. These are our statuses: <mark style="color:red;"><code>pending</code></mark>, <mark style="color:red;"><code>paid</code></mark>, <mark style="color:red;"><code>denied</code></mark>, <mark style="color:red;"><code>expired</code></mark></td></tr><tr><td><mark style="color:red;"><code>payment_method</code></mark></td><td>The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.</td></tr><tr><td><mark style="color:red;"><code>created_at</code></mark></td><td>The date and time the transaction was created.</td></tr><tr><td><mark style="color:red;"><code>updated_at</code></mark></td><td>The date and time the transaction was updated with new status.</td></tr></tbody></table>




---

[Next Page](/llms-full.txt/1)