On This Page
FILTER BY TAG

Check Status for a Transaction

You can retrieve the current status of any API request by requesting a check status. Use the check status request as often as necessary to obtain the information you need.

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 Status

Example: Checking Status

Request
{
    "agreementInformation": {
        "agreementId": "agreementId"
    },
    "clientReferenceInformation": {
        "code": "12"
    },
    "processingInformation": {
        "actionList": [
            "AP_STATUS"
        ]
    },
    "paymentInformation": {
        "customer": {
            "customerId": "201.1"
        },
        "paymentType": {
            "method": {
                "name": "payPal"
            },
            "name": "eWallet"
        }
    }
}
Response to a Successful Request
{
    "submitTimeUtc": "2024-09-12T15:45:31Z",
    "orderInformation": {
        "referenceId": "default",
        "description": "1bc",
        "merchantDescriptor": "Demo-Merchant"
    },
    "processorInformation": {
        "transactionId": "2F930071T65206814",
        "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=2F930071T65206814"
    },
    "paypalgateway_mid": "J4QDR26LU6K4A",
    "message": "Successful",
    "reconciliationId": "7261559298496016901991",
    "paypalgateway_merchant_email": "sb-g66r631737562@business.example.com",
    "status": "PAYER_ACTION_REQUIRE",
    "id": "7261559585096017001991"
}

Response Statuses for Checking Status

Cybersource
 responds to your request with one of these statuses in the
status
 response field. The possible statuses are dependent on the API service you are retrieving a status for.
Authorization
  • COMPLETED
    : The authorized funds were successfully captured.
  • INVALID_REQUEST
    : The authorization request was not successful. Send a new authorization request.
  • PENDING
    : The authorization request was successful, and PayPal is reviewing the request. Use the check status request as often as necessary until the status updates.
  • REVERSED
    : The authorized funds were released back to the customer and cannot be captured.
Authorization Reversal
  • REVERSED
    : The reversal request was successful, and the authorized funds are released from hold.
  • INVALID_REQUEST
    : The reversal request was not successful. Send a new reversal request.
Capture
  • COMPLETED
    : The funds were successfully captured, and the payment is complete.
  • DECLINED
    : The funds were not captured because PayPal declined the request after a review.
  • INVALID_REQUEST
    : The capture request was not successful. Send a new capture request.
  • PENDING
    : The capture request was successful and is being reviewed by PayPal. Use the check status request as often as necessary until the status updates. For more information, see Check Status for a Transaction.
Re-authorization
  • COMPLETED
    : The request was successful and the authorization is updated.
  • INVALID_REQUEST
    : The request was not successful. Send a new authorization request.
  • PENDING
    : The request was successful, and PayPal is reviewing the request. Use the check status request as often as necessary until the status updates.
Refund
  • REFUNDED
    : The captured funds were successfully refunded to the customer's account. This status can also occur during a customer dispute, such as a chargeback or reversal.
  • INVALID_REQUEST
    : The refund request was not successful. Send a new refund request.
  • PENDING
    : The refund request was successful and is being reviewed by PayPal. Use the check status request as often as necessary until the status updates.
Sale
  • COMPLETED
    : The sale successfully processed, and the payment is complete.
  • DECLINED
    : The sale request is declined. Send a new sale request.
  • INVALID_REQUEST
    : The sale request is not successful. Send a new sale request.
  • PENDING
    : The sale request is successful and is being reviewed by PayPal. Use the check status request as often as necessary until the status updates.
RELATED TO THIS PAGE