documentation
Search…
Integration guide
Instant Payment Notification (IPN) / Webhooks
Queries
Compliance
Reference
Recurring Payments
You can perform recurring payments by just adding one additional parameter,
recurringType, to the payment request.A recurring workflow consists of two phases:
- 1.
- 2.​Subsequent payment requests without a cvv using a token previously stored during the initial payment.
Sending the initial Payment
During the initial payment, marked by the parameter
recurringType with the value INITIAL, the customer is present. Therefore, this initial request should contain additional parameters that authenticate the customer like card.cvv for card payments.Quick links
- COPYandPAY
- Server-to-Server
COPYandPAY - INITIAL
In COPYandPAY you get this behaviour out of the box, so all you have to do is to follow the COPYandPAY Integration guide and add the following parameter to the /v1/checkouts request in step 1:
1
recurringType=INITIAL
2
createRegistration=true (to create a registrationid for future repeated payments).
Copied!
Example COPYandPAY INITIAL Request
Response
Show the checkout page
Get the payment status
1
curl https://test.oppwa.com/v1/checkouts \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "amount=1.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 "recurringType=INITIAL" \
21
-d "testMode=EXTERNAL" \
22
-d "createRegistration=true" \
23
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"result":{
3
"code":"000.200.100",
4
"description":"successfully created checkout"
5
},
6
"buildNumber":"[email protected] 13:28:08 +0000",
7
"timestamp":"2016-06-02 23:41:28+0000",
8
"id":"5D6AE9181EB6E8899F2AF0B3F9796249.sbg-vm-tx01"
9
}
Copied!
1
<form action="{shopperResultUrl}" class="paymentWidgets"> VISA MASTER AMEX DINERS DISCOVER ELO JCB</form>
2
​
Copied!
1
curl -G https://test.oppwa.com/v1/checkouts/{id}/payment \
2
\
3
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
Response:
1
{
2
"id":"8a8294495507351b0155137ed0fd7fc4",
3
"registrationId":"8a82944a5507355f0155137ecf1209ff",
4
"paymentType":"DB",
5
"paymentBrand":"VISA",
6
"amount":"1.00",
7
"currency":"BRL",
8
"descriptor":"123 Usage",
9
"merchantTransactionId":"Order Number 123",
10
"recurringType":"INITIAL",
11
"result":{
12
"code":"000.100.112",
13
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
14
},
15
"card":{
16
"bin":"411111",
17
"last4Digits":"1111",
18
"holder":"Jose da Silva",
19
"expiryMonth":"05",
20
"expiryYear":"2018"
21
},
22
"customer":{
23
"givenName":"Jose",
24
"surname":"da Silva",
25
"merchantCustomerId":"12345678909",
26
"email":"[email protected]",
27
"ip":"123.123.123.123"
28
},
29
"billing":{
30
"street1":"Rua Itapeva 547",
31
"city":"Sao Paulo",
32
"state":"SP",
33
"postcode":"01332000",
34
"country":"BR"
35
},
36
"customParameters":{
37
"product":"1 month membership",
38
"merchant_website":"www.store.com"
39
},
40
"risk":{
41
"score":"100"
42
},
43
"buildNumber":"[email protected] 13:28:08 +0000",
44
"timestamp":"2016-06-02 23:42:09+0000",
45
}
46
​
Copied!
Using the server-to-server integration, you have the option to append the parameter
recurringTypeto the initial /v1/payments request which also stores the card data:Server-to-Server - INITIAL
Using the server-to-server integration, you have the option to append the parameter
recurringTypeto the initial /v1/payments request which also stores the card data:1
recurringType=INITIAL
2
createRegistration=true (to create a registrationid for future repeated payments).
Copied!
For some cases you might want to use an alternative approach: If the shopper just registered his data without sending a payment at the same time, you would have sent his payment directly to the /v1/registrations endpoint as described here. In the same way as described above, the
recurringType=INITIAL parameter can be added to the request to indicate that this is the first in a series of recurring payments.Example Server-to-Server INITIAL Request
Response
1
curl https://test.oppwa.com/v1/payments \
2
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
3
-d "merchantTransactionId=Order Number 123" \
4
-d "customer.merchantCustomerId=12345678909" \
5
-d "amount=1.00" \
6
-d "currency=BRL" \
7
-d "paymentType=DB" \
8
-d "paymentBrand=VISA" \
9
-d "card.number=4111111111111111" \
10
-d "card.holder=Jose da Silva" \
11
-d "card.expiryMonth=05" \
12
-d "card.expiryYear=2028" \
13
-d "card.cvv=123" \
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 "recurringType=INITIAL" \
27
-d "testMode=EXTERNAL" \
28
-d "createRegistration=true" \
29
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8ac7a4a06a585554016a5ac4134739ca",
3
"registrationId":"8ac7a4a16a585296016a5ac4108a2bbf",
4
"paymentType":"DB",
5
"paymentBrand":"VISA",
6
"amount":"1.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
},
14
"card":{
15
"bin":"411111",
16
"last4Digits":"1111",
17
"holder":"Jose da Silva",
18
"expiryMonth":"05",
19
"expiryYear":"2028"
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
"merchant_website":"www.store.com",
37
"product":"1 month membership",
38
"OPP_card.bin":"411111"
39
},
40
"risk":{
41
"score":"0"
42
},
43
"buildNumber":"[email protected] 08:51:22 +0000",
44
"timestamp":"2019-04-26 17:49:21+0000",
45
"ndc":"8a8294174e918ca6014e9c6f5ae12a9c_16d4adfc8c1b4494b7dedc6d6a262f70"
46
}Sending a repeated Payment
Copied!
Sending a repeated Payment
Any payment request following the initial one must have the parameter
recurringType with the value REPEATED. This flag not only indicates that the request is part of a series of payments on this account, but also tells the payment system that no user is present and therefore the parameter card.cvv is not part of the request. This fact in combination with the stored payment data of the registration greatly reduces the number of parameters of such a request:1
recurringType=REPEATED
Copied!
COPYandPAY - REPEATED
Example COPYandPAY REPEATED request
Response
1
curl https://test.oppwa.com/v1/registrations/{id}/payments \
2
-d "entityId=8a8294174e918ca6014e9c73d69c2ab3" \
3
-d "amount=1.00" \
4
-d "currency=BRL" \
5
-d "paymentType=DB" \
6
-d "customer.merchantCustomerId=12345678909" \
7
-d "testMode=EXTERNAL" \
8
-d "recurringType=REPEATED" \
9
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8ac7a49f6a585294016a5ae124bb5624",
3
"paymentType":"DB",
4
"amount":"1.00",
5
"currency":"BRL",
6
"descriptor":"",
7
"result":{
8
"code":"000.100.112",
9
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
10
},
11
"customer":{
12
"merchantCustomerId":"12345678909"
13
},
14
"risk":{
15
"score":"0"
16
},
17
"buildNumber":"[email protected] 08:51:22 +0000",
18
"timestamp":"2019-04-26 18:21:17+0000",
19
"ndc":"8a8294174e918ca6014e9c73d69c2ab3_6864a3cd063447648091a05f44e35811"
20
}
Copied!
Server-to-Server - REPEATED
Example Server-to-Server REPEATED Request
Response
1
curl https://test.oppwa.com/v1/registrations/{id}/payments \
2
-d "entityId=8a8294174e918ca6014e9c73d69c2ab3" \
3
-d "merchantTransactionId=Order Number 123" \
4
-d "customer.merchantCustomerId=12345678909" \
5
-d "amount=21.00" \
6
-d "currency=BRL" \
7
-d "paymentType=DB" \
8
-d "recurringType=REPEATED" \
9
-d "testMode=EXTERNAL" \
10
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Copied!
1
{
2
"id":"8ac7a4a06a585554016a5ae9905b5c4d",
3
"paymentType":"DB",
4
"amount":"21.00",
5
"currency":"BRL",
6
"descriptor":"",
7
"merchantTransactionId":"Order Number 123",
8
"result":{
9
"code":"000.100.112",
10
"description":"Request successfully processed in 'Merchant in Connector Test Mode'"
11
},
12
"customer":{
13
"merchantCustomerId":"12345678909"
14
},
15
"risk":{
16
"score":"0"
17
},
18
"buildNumber":"[email protected] 08:51:22 +0000",
19
"timestamp":"2019-04-26 18:30:18+0000",
20
"ndc":"8a8294174e918ca6014e9c73d69c2ab3_37eff6eeff5a40d7b7fb86ffdeba564c"
21
}
Copied!
Last modified 1yr ago