On This Page

Check a Request Status

You can retrieve the status of a pending sale or refund by sending a check status request.

When a pending status updates, a check status response includes the transaction's new status. Thunes sometimes needs to review a service request, which causes a transaction to initially respond with a pending status. The check status request requires you to include the request ID from the pending transaction response you are checking the status of. The request ID is located in the

response field. Cybersource recommends that you send a check status request hourly until the status updates from pending.

Endpoints

Production:

POST https://api.cybersource.com/pts/v2/refresh-payment-status/{id}

Test:

POST https://apitest.cybersource.com/pts/v2/refresh-payment-status/{id}

Set the {id}
to the request ID of the API service you are retrieving.

Response Statuses

Cybersource responds to your check status request with one of these statuses in the

status

field:

Check Status Responses for a Sale: ABANDONED
: The customer did not complete the payment using the redirect URL.
FAILED
: The service request failed. A failed request can be due to either Bizum rejecting the transaction or a technical error.
FUNDED
: The settled amount is funded to the merchant bank account.
PENDING
: The service request is accepted but is not completed. Request the check status service to retrieve status updates.
SETTLED
: The sale request is settled for the requested amount.
Check Status Responses for a Refund: FAILED
: The service request failed. A failed request can be due to either Bizum rejecting the transaction or a technical error.
REFUNDED
: The settled amount is successfully refunded.

Required Fields for Checking Status

clientReferenceInformation.code
paymentInformation.paymentType.method.name: Set to
BIZUM
.
paymentInformation.paymentType.name: Set to
bankTransfer
.
processingInformation.actionList: Set to
AP_STATUS
.

Example: Checking a Request Status

Request

{
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "paymentInformation": {
        "paymentType": {
            "method": {
                "name": "BIZUM"
            },
            "name": "bankTransfer"
        }
    },
    "processingInformation": {
        "actionList": "AP_STATUS"
    }
}

Response to a Successful Request

{
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "id": "7652140009076673004807",
    "processorInformation": {
        "responseDetails": "00004",
        "token": "524844527123",
        "responseCode": "00004"
    },
    "reconciliationId": "XFZ3ZIR241FRH",
    "status": "SETTLED"
}