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.

Generate Orders

Creating a Deposit REDIRECT order:

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

{
  "order": {
    "code": "123",
    "notification_url": "https://yoursystem.com/postback/",
    "redirect_url": "https://yoursystem.com/finish_checkout?auto_redirect=true",
    "value": 50.00,
    "additional_info": "A description of your order, as a string",
    "payment_method": "deposit"
  }
}

Params descriptions

Field	Description	Value Type	Requirement
order.code	Order reference in your system	String	Required
order.notification_url	URL to notify when status changes	String	Required
order.redirect_url	URL for automatic redirection after checkout ends	String	Optional
order.value	Total order value	Number (Decimal)	Required
order.additional_info	Additional description of the order	String	Required
order.payment_method	Payment method	String	Required

On a successful request HTTP 200 status code, the response will include the following parameters:

{
  "form_id": "dbcedec8-f587-4203-8aa4-a74da83fb32a", 
  "url": "https://latamgateway.com/checkout/payment/dbcedec8-f587-4203-8aa4-a74da83fb32a" 
}

Business errors due to incorrect or missing parameters are returned with an HTTP 400 status code. The response will indicate which parameter is invalid or missing.

{
    "message": "Payment method not supported"
}