PIX

Introduction

The Brazilian Instant Payment System (PIX) is a new payment method created by the Central Bank of Brazil. It is a fast, secure and convenient way to make payments and transfer money. PIX is available 24/7, including weekends and holidays, and it is free for individuals and small businesses. Currently is the most popular payment method in Brazil.

Getting Started

• Generate Order
• Reverse Order

Generate Order

Creating a Pix REDIRECT order:

POST /api/v1/checkout/form
Host: sulpayments.ch
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

{
  "order":{
    "code":"123", # Order reference in your system (required)
    "notification_url":"https://yoursystem.com/postback/", # Where we'll notify when status changes (required)
    "redirect_url":"https://yoursystem.com/finish_checkout?auto_redirect=true", # If filled, at the end of checkout we'll automatic redirect to that page (optional)
    "value":50.00, # (required)
    "additional_info":"A description of your order, as a string", # (required)
    "payment_method":"pix" # (required)
  }
}

The response will be:

{
  "form_id": "dbcedec8-f587-4203-8aa4-a74da83fb32a", # Order reference in our system. You should save that.
  "url": "https://sulpayments.ch/checkout/payment/dbcedec8-f587-4203-8aa4-a74da83fb32a" # Form URL, redirect your customer to here
}

Reverse Order

To reverse the order:

POST /api/v1/order/{order_id}/reverse
Host: sulpayments.ch
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

If your request is successful, you will receive a response to the following:

{
  "message": "message": "Refund requested. Waiting for confirmation from the bank."
}

Business errors are returned with a 400 status code. The response will be:

{
  "message": "Only PIX and PicPay transactions can be refunded."
}