Backoffice Operations
You can perform different types of backoffice operations using our Server-to-Server REST API.
Quick links
Note: Backoffice operations can be performed against initial payments that were generated using COPYandPAY or Server-to-Server. The referencedPaymentId
is the value return in the id
JSON field.
Capture (CP) an authorization
A capture is used to request clearing for previously authorized funds. A capture request is performed against a previous preauthorization (PA) payment by referencing its payment.id and sending a POST request over HTTPS to the /v1/payments/{id} endpoint. Captures can be for full or partial amounts. Note that a capture is a one-time event. Once a capture (even partial) has been performed, the preauthorization is not valid anymore for future captures.
curl https://test.oppwa.com/v1/payments/{id} \
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
-d "amount=1.00" \
-d "currency=BRL" \
-d "paymentType=CP" \
-d "testMode=EXTERNAL" \
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Refund (RF) a payment
A refund is performed against a previous payment, referencing its payment.id
by sending a POST request over HTTPS to the /v1/payments/{id} endpoint. A refund can be performed against debit (DB) or captured preauthorization (PA->CP) payment types. Where supported, the amount field can be used to process a partial or full amount.
curl https://test.oppwa.com/v1/payments/{id} \
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
-d "amount=1.00" \
-d "currency=BRL" \
-d "paymentType=RF" \
-d "testMode=EXTERNAL" \
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Allowed Refund timelines
Country
Refund timeline (days after purchase)
Argentina
90 days.
Brazil
90 days.
Chile
11 months.
Colombia
120 days.
México
90 days.
Perú
6 months.
Reverse (RV) a payment
A reversal is performed against a previous payment, referencing its payment.id
by sending a POST request over HTTPS to the /v1/payments/{id} endpoint. A reversal can be sent against debit (DB) or preauthorization (PA) payment types. When reversing a card payment and if sent within 72 hours of the original request, a reversal causes an authorization reversal request to be sent the card issuer to clear the funds held against the authorization.
curl https://test.oppwa.com/v1/payments/{id} \
-d "entityId=8a8294174e918ca6014e9c6f5ae12a9c" \
-d "paymentType=RV" \
-d "testMode=EXTERNAL" \
-H "Authorization: Bearer OGE4Mjk0MTcyODFiOGVlMzAxMjgyOTkwNjZmNTBjZGJ8ZGVtbw=="
Last updated