Boleto Bancário

Integration

Two ways to integrate via Client API and Server API

MyCheckout hosted payment pages

No extra fields are required when creating a MyCheckout hosted payment pages session. Client API JSON Request (Create Hosted Checkout)

{
    "order": {
        "amountOfMoney": {
            "currencyCode": "BRL",
            "amount": 100
        },
        "customer": {
            "billingAddress": {
                "countryCode": "BR"
            }
        }
    },
    "hostedCheckoutSpecificInput": {
        "variant": "testVariant",
        "locale": "en_GB"
    }
}

Server API integration

Once the payment has been created you will receive a response with status REDIRECTED. Next to that, the response will contain a MerchantAction with a MerchantActionType of SHOW_INSTRUCTIONs. Full show data that will be returned is shown in the tables below. You can use our renderingData service or start use the merchant Action in order to fully customize the user experience Merchant Action

Key	Value	Note
PAYERNAME	String(60)	Consumer name
CPFCNPJ	String(14)	Consumer Fiscalnumber 11 numeric value, Company fiscalnumber 14 numeric value
EXPIRATIONDATE	String(8)	Boleto voucher expiration date
BARCODE	String(64)	The String is a Base64 encoded png image. Inline in your HTML display the Bar code to the consumer
BOLETOTYPABLELINE	String(47)	Boleto bar code refenence number, consumer can use it to pay via banking application
CURRENCYCODE	String (3)	Displayed currency to the consumer
AMOUNT	String(12)	Total checkout amount

renderingData Service This property contains the blob with data for the instructions rendering service. This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}} This instructions page rendering service accepts the following parameters:

instructionsRenderingData (required, the content of this property)
locale (optional, if present overrides default locale, e.g. "en_GB")
variant (optional, code of a variant, if present overrides default variant, e.g. "100")

You can offer a link to a customer to see an instructions page for a payment done earlier. Because of the size of the instructionsRenderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call. The instructionsRenderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the instructionsRenderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls

Action type	Value	Note
RederingData	-	Enum

Server API JSON Request (Create Payment)

{
  "order": {
    "amountOfMoney": {
      "currencyCode": "BRL",
      "amount": 2400
    },
    "additionalInput": {
      "airlineData": {
        "code": "123",
        "name": "KLM",
        "merchantCustomerId": "5678"
      }
    },
    "customer": {
      "merchantCustomerId": "1234",
      "fiscalNumber": "21298750091",
      "personalInformation": {
        "name": {
          "title": "Mr.",
          "firstName": "Wile",
          "surnamePrefix": "E.",
          "surname": "Coyote"
        },
        "gender": "male",
        "dateOfBirth": "19490917"
      },
      "companyInformation": {
        "name": "Acme Labs"
      },
      "languageCode": "en",
      "billingAddress": {
        "street": "Desertroad",
        "houseNumber": "13",
        "additionalInfo": "b",
        "zip": "21200654",
        "city": "Denver",
        "state": "Utah",
        "stateCode": "RJ",
        "countryCode": "BR"
      },
      "shippingAddress": {
        "name": {
          "title": "Miss",
          "firstName": "Road",
          "surname": "Runner"
        },
        "street": "Desertroad",
        "houseNumber": "1",
        "additionalInfo": "Suite II",
        "zip": "21200654",
        "city": "Monument Valley",
        "state": "Utah",
        "countryCode": "BR"
      },
      "contactDetails": {
        "emailAddress": "wile.e.coyote@acmelabs.com",
        "phoneNumber": "+1234567890",
        "faxNumber": "+1234567891",
        "emailMessageType": "html"
      },
      "vatNumber": "1234AB5678CD"
    },
    "references": {
      "merchantOrderId": "123456",
      "merchantReference": "rXK5SOKMR1LcBK8Pbuxp5WPaOLLlrx",
      "invoiceData": {
        "invoiceNumber": "000000123",
        "invoiceDate": "20140306191500"
      },
      "descriptor": "Fast and Furry-ous"
    },
    "items": [
      {
        "amountOfMoney": {
          "currencyCode": "BRL",
          "amount": 1400
        },
        "invoiceData": {
          "nrOfItems": "1",
          "pricePerItem": 1400,
          "description": "ACME Super Outfit"
        }
      },
      {
        "amountOfMoney": {
          "currencyCode": "BRL",
          "amount": 1000
        },
        "invoiceData": {
          "nrOfItems": "10",
          "pricePerItem": 200,
          "description": "Asperin"
        }
      }
    ]
  },
  "cashPaymentMethodSpecificInput": {
    "paymentProductId": 1503
  }
}

Server API JSON Response

{
   "creationOutput" : {
      "additionalReference" : "12EsDh3gXA4uWAQkSmUk",
      "externalReference" : "12EsDh3gXA4uWAQkSmUkqWrtPbnDUi"
   },
   "merchantAction" : {
      "actionType" : "SHOW_INSTRUCTIONS",
      "renderingData" : "eyJ0eXBlIjoicnBwSG9zdGVkQ2hlY2tvdXQiLCJob3N0ZWRTZXNzaW9uU3BlY2lmaWNJbnB1dCI6eyJ0eXBlIjoicnBwU3BlY2lmaWNJbnB1dCIsImNhcnQiOnsiY3VycmVuY3lTeW1ib2wiOiJSJCIsImxpbmVJdGVtcyI6W3siZGVzY3JpcHRpb24iOiJBQ01FIFN1cGVyIE91dGZpdCIsIm5yT2ZJdGVtcyI6IjEiLCJwcmljZVBlckl0ZW0iOjE0MDAsInRvdGFsUHJpY2UiOjE0MDB9LHsiZGVzY3JpcHRpb24iOiJBc3BlcmluIiwibnJPZkl0ZW1zIjoiMTAiLCJwcmljZVBlckl0ZW0iOjIwMCwidG90YWxQcmljZSI6MTAwMH1dLCJ0b3RhbFByaWNlIjoyNDAwfSwicmV0dXJuQ2FuY2VsU3RhdGUiOmZhbHNlfSwiY3JlYXRlZFBheW1lbnRPdXRwdXQiOnsicGF5bWVudCI6eyJpZCI6IjAwMDAwMDk5MzAxMDAwMDYzODI3MDAwMDEwMDAwMSIsInN0YXR1cyI6IlBFTkRJTkdfUEFZTUVOVCJ9LCJtZXJjaGFudEFjdGlvbiI6eyJhY3Rpb25UeXBlIjoiU0hPV19JTlNUUlVDVElPTlMiLCJzaG93RGF0YSI6W3sia2V5IjoiUEFZRVJOQU1FIiwidmFsdWUiOiJXSUxFIENPWU9URSJ9LHsia2V5IjoiQ1BGQ05QSiIsInZhbHVlIjoiMjEyOTg3NTAwOTEifSx7ImtleSI6IkVYUElSQVRJT05EQVRFIiwidmFsdWUiOiIwNTA3MjAxOSJ9LHsia2V5IjoiQkFSQ09ERSIsInZhbHVlIjoiaVZCT1J3MEtHZ29BQUFBTlNVaEVVZ0FBQWFRQUFBQXFBUUFBQUFEVStoS0VBQUFBVmtsRVFWUjQybVA0dDhyaXhhNUhXbzhYUFhxMHU2dlBha2YzaW5kYUZxLzZyQmIzclhpOHVtT1h4VHFOMXl0ZVBGN2QzV1hWMTkyMzZISFhpOVY5K2g4WVJuV042aHJWTmFwclZOZW9ybEZkbzdvR3BTNEFpelJqYU5NODZ1NEFBQUFBU1VWT1JLNUNZSUk9In0seyJrZXkiOiJCT0xFVE9UWVBBQkxFTElORSIsInZhbHVlIjoiMDAxOTAuMDAwMDkgMDI2MjUuNDQ0MTgzIDk4OTI4LjEzODE3NSAxIDc5NDEwMDAwMjQwMDAwIn0seyJrZXkiOiJDVVJSRU5DWUNPREUiLCJ2YWx1ZSI6IkJSTCJ9LHsia2V5IjoiQU1PVU5UIiwidmFsdWUiOiIyNDAwIn1dfX0sInBhcnRpYWxQYXltZW50SW5wdXQiOnsiYW1vdW50IjoyNDAwLCJjb3VudHJ5Q29kZSI6IkJSIiwiY3VycmVuY3lDb2RlIjoiQlJMIiwiaXNSZWN1cnJpbmciOmZhbHNlLCJtZXJjaGFudElkIjoiOTkzMCIsInBheW1lbnRQcm9kdWN0SWQiOjE1MDN9LCJycHBTcGVjaWZpY0lucHV0Ijp7ImNhcnQiOnsiY3VycmVuY3lTeW1ib2wiOiJSJCIsImxpbmVJdGVtcyI6W3siZGVzY3JpcHRpb24iOiJBQ01FIFN1cGVyIE91dGZpdCIsIm5yT2ZJdGVtcyI6IjEiLCJwcmljZVBlckl0ZW0iOjE0MDAsInRvdGFsUHJpY2UiOjE0MDB9LHsiZGVzY3JpcHRpb24iOiJBc3BlcmluIiwibnJPZkl0ZW1zIjoiMTAiLCJwcmljZVBlckl0ZW0iOjIwMCwidG90YWxQcmljZSI6MTAwMH1dLCJ0b3RhbFByaWNlIjoyNDAwfSwicmV0dXJuQ2FuY2VsU3RhdGUiOmZhbHNlfX0=",
      "showData" : [ {
         "key" : "PAYERNAME",
         "value" : "WILE COYOTE"
      }, {
         "key" : "CPFCNPJ",
         "value" : "21298750091"
      }, {
         "key" : "EXPIRATIONDATE",
         "value" : "05072019"
      }, {
         "key" : "BARCODE",
         "value" : "iVBORw0KGgoAAAANSUhEUgAAAaQAAAAqAQAAAADU+hKEAAAAVklEQVR42mP4t8rixa5HWo8XPXq0u6vPakf3indaFq/6rBb3rXi8umOXxTqN1ytePF7d3WXV19236HHXi9V9+h8YRnWN6hrVNaprVNeorlFdo7oGpS4AizRjaNM86u4AAAAASUVORK5CYII="
      }, {
         "key" : "BOLETOTYPABLELINE",
         "value" : "00190.00009 02625.444183 98928.138175 1 79410000240000"
      }, {
         "key" : "CURRENCYCODE",
         "value" : "BRL"
      }, {
         "key" : "AMOUNT",
         "value" : "2400"
      } ]
   },
   "payment" : {
      "id" : "000000993010000638270000100001",
      "paymentOutput" : {
         "amountOfMoney" : {
            "amount" : 2400,
            "currencyCode" : "BRL"
         },
         "references" : {
            "merchantOrderId" : 123456,
            "merchantReference" : "12EsDh3gXA4uWAQkSmUkqWrtPbnDUi",
            "paymentReference" : "993000059309"
         },
         "paymentMethod" : "cash",
         "cashPaymentMethodSpecificOutput" : {
            "paymentProductId" : 1503
         }
      },
      "status" : "PENDING_PAYMENT",
      "statusOutput" : {
         "isCancellable" : true,
         "statusCategory" : "PENDING_PAYMENT",
         "statusCode" : 55,
         "statusCodeChangeDateTime" : "20190605162652",
         "isAuthorized" : false,
         "isRefundable" : false
      }
   }
}