Refunds a portion or all of the transaction initiated through
.capture
This initiates a request to refund funds that were captured. The amount refunded can be equal to or smaller than the remaining captured amount on the transaction. Multiple partial refunds are allowed by calling india-cards-v1.asynchronousRefund
multiple times with different requestId
within the header. The final result of the refund is supplied by a call to refundResultNotification
. The combination of requestId
within the header and paymentIntegratorAccountId
is the idempotency key, which uniquely identifies this transaction.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example request looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 1
},
"requestId": "G18FCDTLD5B0SR4",
"requestTimestamp": {
"epochMillis": 1482489410000
},
"paymentIntegratorAccountId": "SpeedyPaymentsIndia_INR"
},
"captureRequestId": "G112YZH4XPDV88J",
"refundAmount": {
"amountMicros": "364000000",
"currencyCode": "INR"
}
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": 1482489412366
}
},
"result": {
"acknowledged": {}
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/v1/payment-integrator-authenticated-card-fop-api/asynchronousRefund
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "requestHeader": { object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
capture |
REQUIRED: A unique identifier for the capture to be refunded. This is the |
refund |
REQUIRED: The amount of the refund. This will be a positive number, and should always be less-than or equal-to the remaining balance for the completed redirect payment. |
Response body
This method supports multiple return types. For additional information about what 4XX or 5XX HTTP status code to return with an ErrorResponse
, consult the ErrorResponse
object and HTTP status codes documentation.
Possible response messages | |
---|---|
HTTP 200 Status |
|
HTTP 4XX / 5XX Status |
|
AsynchronousRefundResponse
Response object for the payment integrator hosted india-cards-v1.asynchronousRefund method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: Result of this asynchronous refund. |
AsynchronousRefundResult
Result of this asynchronous refund.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field result . The result of the refund. result can be only one of the following: |
|
acknowledged |
Refund result notification was acknowledged. |