documentation
Search…
Installments
Installment transactions are available for the following transactions:
Country
Method
Type
Observation
Brazil
CC
DB
Debit transaction including all installments
Brazil
CC
PA + CP
PA transaction including all installments + CP
Mexico
CC
DB
Debit transaction including all installments

Channels (entityId) for installments

For the purposes of processing installments transactions, a dedicated channel (entity ID) will be created, per country. The number of installments is determined in the payment request, which is explained in further detail in the “Implementation” section below.
For example:

Brazil

  • BR_CC_Installments

Mexico

  • MX_CC_Installments

Calculation of installments

From a technical perspective, a transaction in installments is one single transaction. The issuing bank handles the charges to the customer, which will occur each month.
The calculation of the installments amount for each month is done by dividing the amount by the number of installments. The resulting value is then added up with a precision of two decimals. In case the result is lower than the amount, the missing fraction is added to the first installment.

Brazil

Example:
Transaction of 100.00 BRL in 3 installments:
  • 100.00 BRL/ 3 = 33,33 BRL
  • 33,33 BRL x 3 = 99,99 BRL
First installment: BRL 33,34 2nd and 3rd installments: BRL 33,33

Mexico

Example:
Transaction of 300.00 MXN in 3 installments:
  • 300.00 BRL/ 3 = 100.00 MXN
First installment: 100.00 MXN 2nd and 3rd installments: 100.00 MXN

Limitations

From a technical perspective, up to 12 installments are allowed. Please check back with the Project Owner the maximum number of installments agreed in your contract.

Minimum amount for an installment

Brazil

The minimum amount for an installment is 5.00 BRL. Ex: Total DB amount 10.00 BRL in 2 installments (5.00 BRL/installment).

Mexico

The minimum total Amount for 3, 6, 9 and 12 installments are:
Installments
Minimum Amount
Example
3 installments
300.00 MXN
300.00 MXN / 3 installments 1000.00 MXN / 3 installments 2000.00 MXN / 3 installments
6 installments
600.00 MXN
600.00 MXN / 6 installments 1000.00 MXN / 6 installments 2000.00 MXN / 6 installments
9 installments
900.00 MXN
900.00 MXN / 9 installments 1000.00 MXN / 9 installments
2000.00 MXN / 9 installments
12 installments
1200.00 MXN
1200.00 MXN / 12 installments 2000.00 MXN / 12 installments 3000.00 MXN / 12 installments
Note: 2, 4, 5, 7, 8, 10 and 11 installments are not supported in Mexico! You should obligatory send exactly 3, 6, 9 or 12 installments in according to the minimum amount above.

Implementation

Installments transactions have a single parameter added to a “normal” transaction: recurring.numberOfInstallments.
PPRO supports two flows for processing Credit and Debit Card transactions, either Debit (DB) Flow or Preauthorization (PA) and Capture (CP) flow. Both flows are valid; please discuss both options with your Account Manager.
  1. 1.
    Debit (DB) flow authorizes and debits card holder’s account in a single step.
  2. 2.
    Preauthorization (PA) and Capture (CP) flow splits authorizes and debiting card holder’s account into two steps.
Note: In Mexico installments are not available for Amex PA (Preauthorization)!
Note: For recurring transactions the CVV is not mandatory!

Test Cards

Brazil

Brand
Number
Expiry
CVV
VISA
4532064331732524
05/2025
123
Master
5228644111420691
05/2025
123

Mexico

Brand
Number
Expiry
CVV
VISA
4242424242424242
05/2023
123
Master
5105105105105100
05/2023
123

COPYandPAY - Installments

Debit (DB)

Installments COPYandPAY Debit (DB) Request
Response
1
curl https://test.oppwa.com/v1/checkouts \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=100.00" \
4
-d "currency=BRL" \
5
-d "paymentType=DB" \
6
-d "merchantTransactionId=Order Number 123" \
7
-d "customer.merchantCustomerId=12345678909" \
8
-d "customer.givenName=Jose" \
9
-d "customer.surname=da Silva" \
10
-d "customer.email= [email protected]" \
11
-d "customer.ip=123.123.123.123" \
12
-d "descriptor=123 Usage" \
13
-d "billing.city=Sao Paulo" \
14
-d "billing.country=BR" \
15
-d "billing.state=SP" \
16
-d "billing.street1=Rua Itapeva 547" \
17
-d "billing.postcode=01332000" \
18
-d "customParameters[product]=1 month membership" \
19
-d "customParameters[merchant_website]=www.store.com" \
20
-d "recurring.numberOfInstallments=3" \
21
-d "recurringType=INITIAL" \
22
-d "testMode=EXTERNAL" \
23
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"result":{
3
"code":"000.200.100",
4
"description":"successfully created checkout"
5
},
6
"buildNumber":"[email protected] 03:42:17 +0000",
7
"timestamp":"2019-05-07 15:36:03+0000",
8
"ndc":"6B2F955A6E4EB97C8C3FB1108B13484A.uat01-vm-tx04",
9
"id":"6B2F955A6E4EB97C8C3FB1108B13484A.uat01-vm-tx04"
10
}
Copied!
To create the payment form you just need to add the following lines of HTML/Javascript to your page and populating the following variables • The checkout id that you got in the response from step 1
1
<script src="https://test.oppwa.com/v1/paymentWidgets.js?checkoutId={checkoutId}"></script>
Copied!
The shopperresultUrl, is the page on your site where the customer should be redirected to after the payment is processed and the brands that will be available
1
<form action="{shopperResultUrl}" class="paymentWidgets"> VISA MASTER AMEX DINERS DISCOVER ELO JCB</form>
Copied!
Checkout
After you input the credit card data on the form above, the request for payment is processed.

PreAuthorization (PA) + Capture (CP)

Installments COPYandPAY PreAuthorization (PA) Request
Response
1
curl https://test.oppwa.com/v1/checkouts \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=100.00" \
4
-d "currency=BRL" \
5
-d "paymentType=PA" \
6
-d "merchantTransactionId=Order Number 123" \
7
-d "customer.merchantCustomerId=12345678909" \
8
-d "customer.givenName=Jose" \
9
-d "customer.surname=da Silva" \
10
-d "customer.email= [email protected]" \
11
-d "customer.ip=123.123.123.123" \
12
-d "descriptor=123 Usage" \
13
-d "billing.city=Sao Paulo" \
14
-d "billing.country=BR" \
15
-d "billing.state=SP" \
16
-d "billing.street1=Rua Itapeva 547" \
17
-d "billing.postcode=01332000" \
18
-d "customParameters[product]=1 month membership" \
19
-d "customParameters[merchant_website]=www.store.com" \
20
-d "recurring.numberOfInstallments=3" \
21
-d "recurringType=INITIAL" \
22
-d "testMode=EXTERNAL" \
23
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"result":{
3
"code":"000.200.100",
4
"description":"successfully created checkout"
5
},
6
"buildNumber":"[email protected] 03:42:17 +0000",
7
"timestamp":"2019-05-07 15:46:30+0000",
8
"ndc":"9407F5C5F945F4FC47C67B8DD4542E1F.uat01-vm-tx02",
9
"id":"9407F5C5F945F4FC47C67B8DD4542E1F.uat01-vm-tx02"
10
}
Copied!
To create the payment form you just need to add the following lines of HTML/Javascript to your page and populating the following variables • The checkout id that you got in the response from step 1
1
<script src="https://test.oppwa.com/v1/paymentWidgets.js?checkoutId={checkoutId}"></script>
Copied!
The shopperresultUrl, is the page on your site where the customer should be redirected to after the payment is processed and the brands that will be available
1
<form action="{shopperResultUrl}" class="paymentWidgets"> VISA MASTER AMEX DINERS DISCOVER ELO JCB</form>
Copied!
Checkout

Get the payment status - Preauthorization (PA)

Request
Response
1
curl -G https://test.oppwa.com/v1/checkouts/{id}/payment \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8ac7a4a26a8f88ad016a931aaa893b0d",
3
"paymentType":"PA",
4
"paymentBrand":"VISA",
5
"amount":"100.00",
6
"currency":"BRL",
7
"descriptor":"123 Usage",
8
"merchantTransactionId":"Order Number 123",
9
"recurringType":"INITIAL",
10
"result":{
11
"code":"000.100.112",
12
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
13
},
14
"card":{
15
"bin":"411111",
16
"last4Digits":"1111",
17
"holder":"Integration test",
18
"expiryMonth":"10",
19
"expiryYear":"2019"
20
},
21
"customer":{
22
"givenName":"Jose",
23
"surname":"da Silva",
24
"merchantCustomerId":"12345678909",
25
"email":"[email protected]",
26
"ip":"123.123.123.123"
27
},
28
"billing":{
29
"street1":"Rua Itapeva 547",
30
"city":"Sao Paulo",
31
"state":"SP",
32
"postcode":"01332000",
33
"country":"BR"
34
},
35
"customParameters":{
36
"SHOPPER_EndToEndIdentity":"35b4d1421d09b7eb9fdf753fefd30bf80d033c6842b8b45633bfb9e68137ebbf",
37
"product":"1 month membership",
38
"CTPE_DESCRIPTOR_TEMPLATE":"${USAGE}",
39
"merchant_website":"www.store.com"
40
},
41
"risk":{
42
"score":"0"
43
},
44
"buildNumber":"[email protected] 03:42:17 +0000",
45
"timestamp":"2019-05-07 16:22:40+0000",
46
"ndc":"694725F6D8760E88260091ACB963E33C.uat01-vm-tx04",
47
"recurring":{
48
"numberOfInstallments":3
49
}
50
}
Copied!

Capture the payment:

CP (Capture) Request
Response
1
curl https://test.oppwa.com/v1/payments/{id} \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=100.00" \
4
-d "currency=BRL" \
5
-d "paymentType=CP" \
6
-d "testMode=EXTERNAL" \
7
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8ac7a4a06a8f68dd016a931e64f53696",
3
"referencedId":"8ac7a4a26a8f88ad016a931aaa893b0d",
4
"paymentType":"CP",
5
"amount":"100.00",
6
"currency":"BRL",
7
"descriptor":"123 Usage",
8
"merchantTransactionId":"Order Number 123",
9
"result":{
10
"code":"000.100.112",
11
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
12
},
13
"resultDetails":{
14
"ConnectorTxID1":"8ac7a4a06a8f68dd016a931e64f53696",
15
"connectorInstanceId":"10.2.3.93",
16
"acquirerReturnCode":"6",
17
"ExtendedDescription":"Transaction succeeded",
18
"acquirerTxId3":"8ac7a4a26a8f88ad016a931aaa893b0d",
19
"merchantAccount":"Cielo_ACON3_STAGING",
20
"connectorVersion":"3.2.13",
21
"AcquirerResponse":"000.000.000",
22
"acquirerParentTxId":"400e6474-9f1c-47b0-9031-d1633029ff72",
23
"connectorName":"Cielo",
24
"acquirerInitialTxId":"400e6474-9f1c-47b0-9031-d1633029ff72",
25
"acquirerReturnMessage":"Operation Successful",
26
"acquirerTxId1":"400e6474-9f1c-47b0-9031-d1633029ff72",
27
"acquirerTxId2":"0507012240529#[email protected]"
28
},
29
"customer":{
30
"merchantCustomerId":"12345678909"
31
},
32
"buildNumber":"[email protected] 03:42:17 +0000",
33
"timestamp":"2019-05-07 16:26:44+0000",
34
"ndc":"8a8294174e918ca6014e9c6f5ae12a9c_f0cd5781fa5b4434babfd53456d98314"
35
}
Copied!

Server-to-Server - Installments

Debit (DB)

Installments Server-to-Server Debit (DB) Request
Response
1
curl https://test.oppwa.com/v1/payments \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=15.00" \
4
-d "currency=BRL" \
5
-d "paymentType=DB" \
6
-d "paymentBrand=VISA" \
7
-d "card.number=4111111111111111" \
8
-d "card.holder=Jose da Silva" \
9
-d "card.expiryMonth=05" \
10
-d "card.expiryYear=2020" \
11
-d "card.cvv=123" \
12
-d "merchantTransactionId=Order Number 123" \
13
-d "customer.merchantCustomerId=12345678909" \
14
-d "customer.givenName=Jose" \
15
-d "customer.surname=da Silva" \
16
-d "customer.email= [email protected]" \
17
-d "customer.ip=123.123.123.123" \
18
-d "descriptor=123 Usage" \
19
-d "billing.city=Sao Paulo" \
20
-d "billing.country=BR" \
21
-d "billing.state=SP" \
22
-d "billing.street1=Rua Itapeva 547" \
23
-d "billing.postcode=01332000" \
24
-d "customParameters[product]=1 month membership" \
25
-d "customParameters[merchant_website]=www.store.com" \
26
-d "recurring.numberOfInstallments=3" \
27
-d "recurringType=INITIAL" \
28
-d "testMode=EXTERNAL" \
29
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8a82944a64f528ad0165013c47ab70e7",
3
"paymentType":"DB",
4
"paymentBrand":"VISA",
5
"amount":"15.00",
6
"currency":"BRL",
7
"descriptor":"123 Usage",
8
"merchantTransactionId":"Order Number 123",
9
"result":{
10
"code":"000.100.112",
11
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
12
},
13
"card":{
14
"bin":"411111",
15
"last4Digits":"1111",
16
"holder":"Jose da Silva",
17
"expiryMonth":"05",
18
"expiryYear":"2020"
19
},
20
"customer":{
21
"givenName":"Jose",
22
"surname":"da Silva",
23
"merchantCustomerId":"12345678909",
24
"email":" [email protected] ",
25
"ip":"123.123.123.123"
26
},
27
"billing":{
28
"street1":"Rua Itapeva 547",
29
"city":"Sao Paulo",
30
"state":"SP",
31
"postcode":"01332000",
32
"country":"BR"
33
},
34
"customParameters":{
35
"merchant_website":"www.store.com",
36
"product":"1 month membership"
37
},
38
"risk":{
39
"score":"100"
40
},
41
"buildNumber":"[email protected] 11:16:15 +0000",
42
"timestamp":"2018-08-03 19:20:53+0000",
43
"ndc":"8a8294174e918ca6014e9c6f5ae12a9c_defc7dda58e14b89b96002795a2ead62",
44
"recurring":{
45
"numberOfInstallments":3
46
}
47
}
Copied!

PreAuthorization (PA) + Capture)

Installments Server-to-Server PreAuthorization (PA) Request
Response
Example Capture (CP) Request
Response
1
curl https://test.oppwa.com/v1/payments \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=300.00" \
4
-d "currency=BRL" \
5
-d "paymentType=PA" \
6
-d "paymentBrand=VISA" \
7
-d "card.number=4111111111111111" \
8
-d "card.holder=Jose da Silva" \
9
-d "card.expiryMonth=05" \
10
-d "card.expiryYear=2020" \
11
-d "card.cvv=123" \
12
-d "merchantTransactionId=Order Number 123" \
13
-d "customer.merchantCustomerId=12345678909" \
14
-d "customer.givenName=Jose" \
15
-d "customer.surname=da Silva" \
16
-d "customer.email= [email protected]" \
17
-d "customer.ip=123.123.123.123" \
18
-d "descriptor=123 Usage" \
19
-d "billing.city=Sao Paulo" \
20
-d "billing.country=BR" \
21
-d "billing.state=SP" \
22
-d "billing.street1=Rua Itapeva 547" \
23
-d "billing.postcode=01332000" \
24
-d "customParameters[product]=1 month membership" \
25
-d "customParameters[merchant_website]=www.store.com" \
26
-d "recurring.numberOfInstallments=3" \
27
-d "recurringType=INITIAL" \
28
-d "testMode=EXTERNAL" \
29
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8a82944964f4e0a701650146063971ce",
3
"paymentType":"PA",
4
"paymentBrand":"VISA",
5
"amount":"300.00",
6
"currency":"BRL",
7
"descriptor":"123 Usage",
8
"merchantTransactionId":"Order Number 123",
9
"result":{
10
"code":"000.100.112",
11
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
12
},
13
"card":{
14
"bin":"411111",
15
"last4Digits":"1111",
16
"holder":"Jose da Silva",
17
"expiryMonth":"05",
18
"expiryYear":"2020"
19
},
20
"customer":{
21
"givenName":"Jose",
22
"surname":"da Silva",
23
"merchantCustomerId":"12345678909",
24
"email":" [email protected] ",
25
"ip":"123.123.123.123"
26
},
27
"billing":{
28
"street1":"Rua Itapeva 547",
29
"city":"Sao Paulo",
30
"state":"SP",
31
"postcode":"01332000",
32
"country":"BR"
33
},
34
"customParameters":{
35
"merchant_website":"www.store.com",
36
"product":"1 month membership"
37
},
38
"risk":{
39
"score":"100"
40
},
41
"buildNumber":"[email protected] 11:16:15 +0000",
42
"timestamp":"2018-08-03 19:31:32+0000",
43
"ndc":"8a8294174e918ca6014e9c6f5ae12a9c_263b494adcfe4e16bb56753de4367cf8",
44
"recurring":{
45
"numberOfInstallments":3
46
}
47
}
Copied!
1
curl https://test.oppwa.com/v1/payments/{id} \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=300.00" \
4
-d "currency=BRL" \
5
-d "paymentType=CP" \
6
-d "testMode=EXTERNAL" \
7
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8a82944964f4e0a7016501476ad2747e",
3
"referencedId":"8a82944964f4e0a701650146063971ce",
4
"paymentType":"CP",
5
"paymentBrand":"VISA",
6
"amount":"15.00",
7
"currency":"BRL",
8
"descriptor":"123 Usage",
9
"merchantTransactionId":"Order Number 123",
10
"result":{
11
"code":"000.100.112",
12
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
13
}, "card":{
14
"bin":"411111",
15
"last4Digits":"1111",
16
"holder":"Jose da Silva",
17
"expiryMonth":"05",
18
"expiryYear":"2020"
19
},
20
"customer":{
21
"givenName":"Jose",
22
"surname":"da Silva",
23
"merchantCustomerId":"12345678909",
24
"email":"[email protected]",
25
"ip":"123.123.123.123"
26
},
27
"billing":{
28
"street1":"Rua Itapeva 547",
29
"city":"Sao Paulo",
30
"state":"SP",
31
"postcode":"01332000",
32
"country":"BR"
33
},
34
"buildNumber":"[email protected] 03:42:17 +0000",
35
"timestamp":"2018-08-03 19:33:03+0000",
36
"ndc":"8a8294174e918ca6014e9c6f5ae12a9c_b7ec3dae6b1e40f58f95fe8709c9a069"
37
}
Copied!
Last modified 4mo ago