Orbitall
Introduction#
The acquirer Orbitall is responsible for processing cards from the retail chain itself.
In order to make the payment through the Orbitall acquirer on Carat Portal, in addition to the basic parameters of the REST Transaction creation service and REST Payment effectuation service, others parameters are required and will be sent using the prefixes field described in the Prefixes section.
Carat Portal Interfaces Supported for Integration#
You can use the following interfaces for integration with Orbitall routing:
- REST Payment
- REST Cancel
- Cancel via Portal
REST Payment#
REST Transaction Creation#
The parameters with specific data for the transaction via Orbitall that the virtual store application must send in the REST Transaction creation service:
| Parameter | Description | Format | Required |
|---|---|---|---|
authorizer_id | Authorizer Code on Carat Portal - Use the Orbitall code which is 160 | ≤ 10 A | Yes |
installment_type | Installment type. May be: 3 - installment with interest 4 - installment without interest ou 37 - Consumer Credit. | = 2 N | No |
REST Transaction Effectuation#
The parameters with specific data for the transaction via Orbitall that the virtual store application must send in the REST Transaction creation service:
| Parameter | Description | Format | Required |
|---|---|---|---|
acquirer.prefixes | Element for sending SiTef prefixes. If the prefix that was sent is not supported by card, Carat Portal will invalidate the transaction, preventing that a false impression of the use of a functionality is given. The Orbitall's supported prefixes are described in the Prefixes section. Example: { "key" : "value" } -> { "CICLOS" : "01" } | ≤ 2000 A | Yes |
Prefixes#
| Parameter | Description | Format | Required |
|---|---|---|---|
CICLOS: | 0 (zero) must be sent when the expiration date is on the card or from 1 to 99 indicating the number of cycles to be skipped. To use cycles, a previous configuration in SiTef is necessary. | ≤ 2 N | Yes |
CPLANO: | Plan code negotiated between the authorizer and the establishment. Mandatory when the type of financing is CDC (Consumer Credit). | = 5 AN | No |
TPCDC: | CDC Credit purchase type: 1 – CDC Product 2 – CDC Service. | = 1 N | No |
VLRADD: | Additional amount charged for a safe purchase** , the parameter must follow the format “cc = vv ... vvv”, where: cc = 01 indicates a safe purchase. vv ... vvv indicates the additional amount for the safe purchase*. It can be a maximum lenght of 12 and is the amount WITHOUT a comma. | ≤ 15 AN | No |
* is an insurance offered at the CDC purchase (e.g.: insurance in case of an unemployment). The amount spent on the transaction refers to the total amount (purchase + insurance amount). The cancellation is also made with the total amount. For more details, contact the acquirer.
Authorizer Code#
Orbitall authorizer code is on Carat Portal is 160. For other authorizer codes at Carat Portal, check here.