Bank Transfer

Call the Payouts API to request withdrawal for your customer.

---

POST /v2/payout

Request

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": "[email protected]",
        "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
      }
    }'

Parameters details

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

Response

{
    "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"
	}
    }
}

Response details following the link: overview