Deposit

Introduction

Deposits in Brazil enable individuals to smoothly transfer funds, combining the security of safeguarding money with the convenience of sending payments. Highly utilized across the country, it's a testament to its reliability and ease of use for financial transactions.

Getting Started

• Generate Orders
• List banks information

Generate Orders

Creating a Deposit TRANSPARENT order:

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

{
  "customer": {
    "name": "Customer’s full name",
    "document": "111.222.333-44", # Note 1 below (required)
    "email": "[email protected]", # (required)
    "phone": "11999999999", # (required)
    "birth": "1996-03-09" # (required)
  },
  "order":{
    "code": "123", # Order reference in your system (required)
    "notification_url": "your_payback_notification_url.com", # Where we'll notify when status changes (required)
    "value": 50.00, # (required)
    "additional_info": "Some description of your order as String", # (required)
    "payment_method": "deposit" # (required),
    "bank_slug": "bank" # (required)
  }
}

The document can be a valid CPF or CNPJ. If CNPJ is used, the company name must be passed in the name parameter.

CPF and CNPJ are the Brazilian individual and company identification numbers, respectively.

The response will contain the following parameters:

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "code": "order_id_in_your_system",
  "confirmation_url": "https://sulpayments.ch/7c0b8129-f556-4357-bb6e-8189c2943024", # Redirect URL
}

Business errors are returned with a 403 status code. The response will contain the following parameters:

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "message": "kyc message table below",
  "code": "kyc code table below"
}

KYC RESPONSE CODES DESCRIPTIONS

Code	Message
KYC110	Invalid CPF, please verify your date of birth and CPF number.
KYC111	Invalid CNPJ, please verify your CNPJ number.
KYC112	Different name from the federal revenue register of natural persons.

List banks information

As you need to show your customer the available banks and the selected bank in bank_slug, this endpoint provides all the information needed in your form.

GET /api/v1/banks
Host: sulpayments.ch
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

{
  "banks": [
    {
      "name": "Inter",
      "slug": "inter",
      "owner": "LATAM TECNOLOGIA LTDA.",
      "document": "33.630.661/0001­-50",
      "agency": "0001",
      "account_number": "6609013-0",
      "logo_url": "https://sulpayments.ch/assets/bank_logo/inter-bb9615ccb49e4f8b050158b2cc9e6df321272ea970f6d0192165cecfb82ce098.png",
      "operation": ""
    },
    {
      "name": "Bradesco",
      "slug": "bradesco",
      "owner": "LATAM TECNOLOGIA LTDA.",
      "document": "33.630.661/0001­-50",
      "agency": "0069-8",
      "account_number": "266833-5",
      "logo_url": "https://sulpayments.ch/assets/bank_logo/bradesco-ec55c20e4b86b2601a03905eec710c654fbe7657b5834ab9fded57dcc9fc06ff.png",
      "operation": ""
    },
    {
      "name": "Caixa Econômica Federal",
      "slug": "caixa",
      "owner": "LATAM TECNOLOGIA LTDA.",
      "document": "33.630.661/0001­-50",
      "agency": "1756",
      "account_number": "4949-0",
      "logo_url": "https://sulpayments.ch/assets/bank_logo/caixa-f3f0a161a3a78518065d902dee21cb10e8b4aa26a0fd94f42dd7071c573fc32c.png",
      "operation": "003"
    }
  ]
}