Guides
Status PageDashboardBook a Demo

Nupay - PIX

Suggest Edits

This page presents all information related to the Nupay connection using PIX as payment. Use the following buttons to navigate to the desired section.

General Information

Refunds

Voids

Installments

Chargebacks

Testing Guidelines

Integration Configuration

Production Environment

Connecting with Yuno

Mandatory fields when integrating via Yuno:

first_name
last_name email document_type
document_number
telephone_number
telephone_country_code
items.id
items.title
items.quantity
items.unit_price
country(transaction)

General information

Countries:

brazil-flag
Brazil

Currencies:

BRL

Minimum amount:

R$ 0.01

Maximum amount:

There is no limit for the day (between 6 am and 8 pm or 10 pm), and for the night (between 8pm or 10pm to 6am), the limit is R$ 1.000. Each institution can set its Pix limit as a security and anti-fraud mechanism. The only rule is that this limit cannot be lower than the TED limit or a debit card transaction limit, depending on each case.

Purchase TRX:

Shoppers can pay with Pix when shopping online.

Support for recurrency:

No

Webhoorks:

Yes

Refunds

Refund support:

Yes

Partial refunds:

Yes

Multiple refunds:

Yes

Time to request refund:

A refund can be sent at any moment, there is no maximum deadline.

Time to process refund:

If there are sufficient funds in the merchant account, the refund will be done instantly.

Voids

Void support:

No

Installments

Capability to define the installments when creating the payment:

No

Chargebacks

Notifications of chargebacks:

No

Testing guidelines for sandbox environment

Necessary fields for testing:

API key and API Token.

Limitations/Specifications for testing:

As the system processes requests asynchronously, all valid payment requests return the status PROCESSING.

In the sandbox environment, the order list gets an extra column called Simulation.

When the payment request is in WAITING_PAYMENT_METHOD status, an Approve button appears to simulate payment via QRCode reading, accessing AppLink or by Pix Copia e Cola.

Test steps

To make a payment using PIX, you should follow the steps:

  1. Create Customer
  2. Create Checkout Session
  3. Create One Time Token / Get the token from SDK
  4. Create Payment

Instead of a redirect URL, the Create Payment response provides a QR code image (payment_method.payment_method_detail.bank_transfer.provider_image). After creating the order, you must complete and test the payment and access the NuPay sandbox dashboard with your Nubank credentials. Once logged in, you can approve the transaction in the 'Activities' section.

After approving the payment, its status will change to completo on the NuPay sandbox dashboard. You can check the payment status using the Retrieve Payment by ID. If the payment were approved, the Retrieve Payment by ID response would provide the status SUCCEEDED, and sub_status APPROVED.

Integration configuration

Credentials and steps to obtain them:

These credentials will be provided during the onboarding process, once both parties are able to initiate integration and must be sent on all requests. Credentials are specific for each checkout environment.

Dashboard configuration:

  1. Log in to dashboard.y.uno.
  2. Click Connections and then select NuPay.
  3. Click Connect.
  4. Introduce Name, Token and Key.
  5. Click Connect

Configuration of webhooks in partner:

Through the field callbackUrl during the creation of the order or refund.

Production environment

Specific procedure for a merchant to go live:

Nu has a tactical documentation that brings some scenarios that must be validated before going Live and also a test period where our internal team helps to cover those scenarios to guarantee that everything works fine.


Send feedback

Updated about 2 months ago