On This Page

Check a Status

This section describes how to retrieve the current status of a sale or refund. Send a check status request to know if a pending sale is settled, or to verify that a refund request is refunded. Use the check status request as often as necessary to obtain the information that you need.

The check status request requires the request ID from the sale or refund response. The request ID is in the

response field.

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.

Required Fields for Checking a Status

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

Example: Checking a Status

Request

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

Response to a Successful Request

{
    "clientReferenceInformation": {
        "code": "refnum-1234"
    },
    "id": "7551890187526961804805",
    "processorInformation": {
        "responseDetails": "00001",
        "token": "665437010510",
        "responseCode": "00001"
    },
    "reconciliationId": "XFZ3ZE5XDZTI",
    "status": "PENDING"
}

Response Statuses for Checking a Status

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 Multibanco 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 Multibanco rejecting the transaction or a technical error.
REFUNDED
: The settled amount is successfully refunded.