API Reference

Brasil

The purpose of this guide is to explain how to create a transaction in Brasil step by step. Monnet has available 1 Payment method in Brasil: Online (Banca por internet)

1459

🚧

IMPORTANT REMINDER:

All fields must be included on request no matter if they are required or optional. Also pay attention on payinCustomerName (fist name), payinCustomerLastName , payinCustomerEmail and payinCustomerPhone on each case. This four fields must NOT be sent with empty values on any case.

Bank Transfer

📘

URL

API V3 (for JSON format to generate a ticket):

Certification: https://cert.monnetpayments.com/api-payin/v3/online-payments

Production: https://payin.api.monnetpayments.com/api-payin/v3/online-payments

Request

FieldDescription
payinMerchantIDInteger (Required)
Merchant Identifier for the Payin API.
payinAmountDecimal (Required)
The amount of the transaction. Use 2 decimals.
payinCurrencyString (Required, ISO-4217)
The currency of the transaction
Example
BRL
payinMerchantOperationNumberString (Required, max-lenght = 50)
Reference number of the sale.
This value is used to notify Merchants about a payment.
payinMethodString (Required)
Payment Method Identifier for the Payin API.
EX: BankTransfer
payinVerificationString (Required)
HASH SHA512 of:
payinMerchantID+
payinMerchantOperationNumber+
payinAmount+
payinCurrency+
KeyMonnet
payinTransactionOKURLString (Required)
URL where the customer will be redirected from the online banking if payment was successful (Must be Https)
payinTransactionErrorURLString (Required)
URL where the customer will be redirected from the online banking if payment was wrong.(Must be Https)
payinExpirationTimeInteger (Required)
Time in minutes to expire the token.
Minimum Suggested:
Online: 30 minutes
payinLanguageString (Required, ISO 639-1)
Example: EN, ES, PT, DE, etc.
payinCustomerEmailString (Required)
Contains the customer's email
payinCustomerNameString (Required)
Contains the customer's first name
payinCustomerLastNameString (Required)
Contains the customer's last name
payinCustomerTypeDocumentString (Required)
Contains the customer's type of document. payinCustomerTypeDocument
payinCustomerDocumentString (Required)
Contains the customer's document number
payinCustomerPhoneString (Required)
Contains the customer's mobile number
payinCustomerAddressString (Required)
Customer information
payinCustomerCityString (Required)
Customer information
payinCustomerRegionString (Required)
Customer information
payinCustomerCountryString (Required)
Customer information
payinCustomerZipCodeString (Required)
Customer information
payinCustomerShippingNameString (Required)
Customer information
payinCustomerShippingPhoneString (Required)
Customer information
payinCustomerShippingAddressString (Required)
Customer information
payinCustomerShippingCityString (Required)
Customer information
payinCustomerShippingRegionString (Required)
Customer information
payinCustomerShippingCountryString (Required)
Customer information
payinCustomerShippingZipCodeString (Required)
Customer information
payinRegularCustomerString (Optional)
Customer information
payinCustomerIDString (Optional)
Customer information
payinDiscountCouponString (Optional)
Customer information
payinFilterByString (Optional)
Customer information
payinProductIDString (Required)
Product information
payinProductDescriptionString (Required)
Product information
payinProductAmountString (Required)
Product information
payinDateTimeString (Required)
Date of the transaction
payinProductSkuString (Required)
Product information
payinProductQuantityString (Required)
Product information
URLMonnet (For API v3)String (Required)
Value in cert environment: https://cert.monnetpayments.com/api-payin/v1/online-payments
Value in prod environment:
https://payin.api.monnetpayments.com/api-payin/v1/online-payments
typePost (For API v3)String (Required)
Value: json

Sample request

Pay attention on fields name format, must be Camel Case as shown below:

data: {
  "payinMerchantID": "00",
  "payinAmount": "100.00",
  "payinCurrency": "BRL",
  "payinMerchantOperationNumber": "0000",
  "payinMethod": "bankTransfer",
  "payinVerification": "string",
  "payinCustomerName": "string",
  "payinCustomerLastName": "string",
  "payinCustomerEmail": "[email protected]",
  "payinCustomerPhone": "0000",
  "payinCustomerTypeDocument": "CPF",
  "payinCustomerDocument": "94803638870",
  "payinRegularCustomer": "string",
  "payinCustomerID": "string",
  "payinDiscountCoupon": "string",
  "payinLanguage": "ES",
  "payinExpirationTime": "30",
  "payinDateTime": "YYYY-MM-DD",
  "payinTransactionOKURL": "https://test.com",
  "payinTransactionErrorURL": "https://test.com",
  "payinFilterBy": "string",
  "payinCustomerAddress": "string",
  "payinCustomerCity": "string",
  "payinCustomerRegion": "string",
  "payinCustomerCountry": "Brasil",
  "payinCustomerZipCode": "0000",
  "payinCustomerShippingName": "string",
  "payinCustomerShippingPhone": "0000",
  "payinCustomerShippingAddress": "string",
  "payinCustomerShippingCity": "string",
  "payinCustomerShippingRegion": "string",
  "payinCustomerShippingCountry": "Argentina",
  "payinCustomerShippingZipCode": "0000",
  "payinProductID": "0000",
  "payinProductDescription": "string",
  "payinProductAmount": "0000",
  "payinProductSku": "string",
  "payinProductQuantity": "0000",
  "URLMonnet": "https://cert.monnetpayments.com/api-payin/v1/online-payments",
  "typePost": "json"
}

Response

🚧

V3

For V3 a URL will be returned on the response, the merchant has to redirect the shopper to this URL

{
"url": "https://test.test",
"payinErrorCode": "0000",
"payinErrorMessage": "Successfull process",
"payinTrxOperation": "MONTRX207249992409275755"
}

Important

Just because the shopper is redirected to the payinTransactionOKURL does not mean that the payment has been billed correctly. We recommend you to work with the notification system in the following section.