Cancels a reference number by invalidating it in the integrators system and preventing future payments.
Only a reference number that was previously created by calling generateReferenceNumber is subject to cancellation.
If the endpoint encounters an error while processing the request, the response body from this endpoint should be of type
.ErrorResponse
An example requests looks like:
{
"requestHeader": {
"protocolVersion": {
"major": 2
},
"requestId": "cmVxdWVzdDE",
"requestTimestamp": {
"epochMillis": "1481899949606"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD"
},
"generateReferenceNumberRequestId": "aW50ZWdyYXRvciB0cmFuc2FjdGlvbiBpZA"
}
An example response looks like:
{
"responseHeader": {
"responseTimestamp": {
"epochMillis": "1481907920760"
}
},
"result": {
"success": {}
}
}
HTTP request
POST https://www.integratorhost.example.com/integrator-base-path/refundable-one-time-payment-code-v2/cancelReferenceNumber
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"requestHeader": {
object ( |
Fields | |
---|---|
request |
REQUIRED: Common header for all requests. |
generate |
REQUIRED: |
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 |
|
CancelReferenceNumberResponse
Response object for the cancelReferenceNumber
method.
JSON representation |
---|
{ "responseHeader": { object ( |
Fields | |
---|---|
response |
REQUIRED: Common header for all responses. |
result |
REQUIRED: The result of this |
CancelReferenceNumberResult
Result of this cancelReferenceNumber
call.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field result . Result of this cancelReferenceNumber call. result can be only one of the following: |
|
success |
Reference number successfully cancelled. |
reference |
Reference number has already been paid. Google should expect a call to |