PicPay

Call the PicPay API to request payments via PicPay.

POST /v2/payin

Request

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
        }
    }'

Parameters details

Parameter Type Required Description

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`	yes	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, passport, 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, passport, 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

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

yes

The email address of the customer. This will be used for sending payment confirmations and notifications

customer.phone

string (E.164)

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

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, passport, 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, passport, or driver's license. List of documents allowed. Default: CPF

customer.address.addres_1

string

The primary street address of the customer

customer.address.addres_2

string

Additional address information, such as apartment number or suite

customer.address.city

string

The city in which the customer resides

customer.address.country_code

string

The ISO 3166-1 alpha-3 country code for the customer's address. List of country codes.

customer.address.neightborhood

string

The neighborhood or district of the customer's address

customer.address.number

string

The street number of the address

customer.address.postal_code

string

The postal or ZIP code for the customer's address

customer.address.state

string

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)

The time in seconds until the transaction expires and is no longer valid

branch

string min: 1 | max: 255

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

Response

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

Important

This payment method is different from the PIX
PicPay does not have copy and paste
Need the PicPay app installed
Use payment > url to open PicPay checkout

Response details following the link: overview

Last updated 1 month ago