---
description: Call the Payments API to request payments via Bank Transfer.
---

# 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="../../../../thesmartway/api-requests/document-type">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="../../../../thesmartway/api-requests/country-codes">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="../../../../thesmartway/api-requests/currency-codes">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="../../../../thesmartway/api-requests/country-codes">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**](../../overview)
{% endhint %}
