Web Checkout

Suggest Edits

Web Checkout

Brazil

Checkout Web

1) Checkout Web

Carat Portal supports HTML integration for fast checkout setup and optional parameter control from merchant side.

Main topics

Overview
Flow
Payment without redirecting the customer
HTML 2.0 payment flow without redirect
Payment redirecting customer to authorizer

2) Quick Start

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-quickstart}

Quick start for HTML checkout flow covering transaction creation, redirection and status callback.

Main topics

What you'll need
Creating a payment transaction
Redirecting the user
Receiving a status notification

Example

Request:

curl
--request POST "https://{{url}}/e-sitef/init/json.se"
--header "Content-Type: application/x-www-form-urlencoded"
-d 'request=%7B%22merchant_id%22%3A%22xxxxxxxxxx%22%2C%22amount%22%3A%221800%22%7D'
--verbose

3) Create Pre-Authorization Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pre-autorizacao-html}

Pre-authorization in HTML flow is enabled by sending transaction_type with value preauthorization.

Main topics

Overview
Pre-Authorization request example
Pre-Authorization capture

Example payload

{
  "merchant_id": "codigoDaLoja",
  "amount": "1800",
  "transaction_type": "preauthorization",
  "authorizer_id": "1",
  "installments": "3",
  "installment_type": "4"
}

4) Payment with Card Storage Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-armazenamento}

Allows secure card storage for future transactions in HTML payment flow.

Main topics

Store Notification
Recurring payment
Storage data query

Example payload

{
  "merchant_id": "MERCHANT_ID",
  "amount": "100",
  "order_id": "12345",
  "store_card": "true",
  "additional_data": {
    "payer": {
      "store_identification": "PAYER_ID"
    }
  }
}

5) Create Transaction Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-begin}

Mandatory service to initialize checkout transactions in HTML flow.

Main topics

Transaction creation process
Test tools
Request parameters
Response parameters

Minimal request payload

{
  "merchant_id": "codigoDaLoja",
  "amount": "1800"
}

6) Payment with Multiple Payment Methods

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-domultiplepayment}

Supports checkout with multiple payment methods in a single purchase flow.

Main topics

Flow and pages
Status notification

Key note

Enable additional_data.multiple_payment_methods = true in transaction creation and configure the merchant accordingly.

7) 3DS 2.0 Activation

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-3ds-server-ativacao}

Topic dedicated to 3DS 2.0 activation in the HTML payment journey.

8) Create Recharge Service

_{Source: https://docs.apis-fiserv.com/latam/docs/recarga-html-begin}

Initial service for HTML recharge transactions.

Main topics

Transaction creation process
Test tools
Request parameters
Response parameters

Minimal request payload

{
  "merchant_id": "codigoDaLoja",
  "amount": "1800"
}

9) Transaction Query Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-getstatus}

Used when merchant needs to confirm final transaction status after callback issues.

Main topics

Flow
When to use status query
Status notification POST parameters

Callback example

curl  -X POST \
  https://www.storetest.com.br/status.php \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'cache-control: no-cache' \
  -d 'nsuSitef=315569&nit=9230d962f0afb40db64e082c37564f4b113c3e4fc6a5090c40813c4b0d80ca37&pedido=201808020001&status=CON'

10) Multiple Transaction Payment

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-split}

Split payment feature for marketplaces and scenarios with value distribution across multiple merchants.

Main topics

Supported interfaces
Not allowed features
Required settings in Carat
Parameters (additional_data, inner_transactions)
Status notification
Calling examples

Example payload

{
  "merchant_id": "CODIGO_LOJA1",
  "amount": "15000",
  "order_id": "654321",
  "additional_data": {
    "method": "split",
    "extra_amount": "1000",
    "inner_transactions": [
      {
        "merchant_id": "CODIGO_LOJA2",
        "merchant_usn": "12341234",
        "order_id": "654321",
        "amount": "10000"
      },
      {
        "merchant_id": "CODIGO_LOJA3",
        "merchant_usn": "3456789",
        "order_id": "654321",
        "amount": "4000"
      }
    ]
  }
}

11) Pages Customization Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-html-customizacao}

Customizes checkout pages with CSS/JS and branding assets.

Main topics

Overview
Sending customization files
Multiple merchantId scenarios
Logo customization
Customization examples

Example snippet

<script type="text/javascript" src="/custom/xxx/js/main.js"></script>

JavaScript Payment

12) JavaScript Payment

_{Source: https://docs.apis-fiserv.com/latam/docs/javascript-payment}

JS Payment collects card data via Carat script on merchant page, reducing PCI scope on merchant systems.

Main topics

Flow

13) Quick Start

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-js-quickstart}

Quick start for JavaScript payment flow.

Main topics

Creating a transaction
Payment page of virtual merchant

Example

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxx"
--data-binary
{
    "merchant_usn":"12042142155",
    "order_id":"12042142155",
    "installments":"1",
    "installment_type":"4",
    "authorizer_id":"2",
    "amount":"1000",
    "payment_js":"true"
}
--verbose

14) Transaction Query Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-js-getstatus}

Status query used after success/failure callbacks and for timeout/uncertain outcomes.

15) Transaction Creation Service

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-js-begin}

Mandatory transaction creation step for JS Payment.

Example

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxx"
--data-binary
{
    "merchant_usn":"12042142155",
    "order_id":"12042142155",
    "installments":"1",
    "installment_type":"4",
    "authorizer_id":"2",
    "amount":"1000",
    "payment_js":"true"
}
--verbose

16) Virtual Store's Payment Page

_{Source: https://docs.apis-fiserv.com/latam/docs/pagamento-js-virtualstore-paymentpage}

Merchant payment page must embed Carat JS script and provide callbacks (onSuccess, onFailure, onInvalid).

Main topics

Fields with card data
Calling Carat script
Success/failure callback response
Validation error callback response
Full example page

JavaScript Store

17) Quick Start

_{Source: https://docs.apis-fiserv.com/latam/docs/armazenamento-js-quickstart}

Quick start for JS Store (card storage) flow.

Main topics

Creating a transaction
Page of virtual merchant
Receiving a store notification

Example

curl
--request POST "https://{{url}}/e-sitef/api/v1/store"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "merchant_usn":"16013439434",
   "customer_id":"11122211122"
}
--verbose

18) JavaScript Store

_{Source: https://docs.apis-fiserv.com/latam/docs/javascript-store}

JS Store interface captures card data through Carat script on merchant page in a PCI-oriented model.

Main topics

Flow

19) Virtual Store's Page

_{Source: https://docs.apis-fiserv.com/latam/docs/armazenamento-js-virtualstore-page}

Merchant store page implementation for card storage scripts and callbacks.

Main topics

Fields with card data
Calling Carat script
Success/failure callback response
Validation error callback response
Example

Key field

store_token

20) Transaction Creation Service

_{Source: https://docs.apis-fiserv.com/latam/docs/armazenamento-js-begin}

Mandatory initialization endpoint for JS Store flow.

Main topics

Call details
Request parameters
Response parameters
Resource shown in page: /v1/store

Updated 3 days ago

Did this page help you?