On This Page

Check a Status

Request a check status to retrieve the current status of a transaction request. The check status request is helpful when know when a pending status updates. The check status request requires the request ID from the response of the corresponding request you are attempting to retrieve.

Endpoints

Production:

POST https://api.cybersource.com/pts/v2/payments

Test:

POST https://apitest.cybersource.com/pts/v2/payments

Response Statuses

If you send a check status request to retrieve the current sale status, these are the possible responses:

FAILED

: The sale request failed. A failed request can be due to either Pay by Bank rejecting the transaction or due to a technical error.

FUNDED

: The sale request is funded for the requested amount.

PENDING

: The sale request is accepted but is not complete. Request the check status service to retrieve status updates.

SETTLED

: The sale request is settled for the requested amount.

If you send a check status request to retrieve the current refund status, these are the possible responses:

FAILED

: The refund request failed. A failed request can be due to PayTo Pay by Bank rejecting the transaction or due to a technical error.

PENDING

: The sale request is accepted but is not complete. Request the check status service to retrieve status updates.

REFUNDED

: The settled amount is successfully refunded.

Required Fields for Checking a Status

clientReferenceInformation.code: Set to an 18-character value or less.
paymentInformation.paymentType.method.name: Set to
payToPayByBank
.
paymentInformation.paymentType.name: Set to
bankTransfer
.
processingInformation.actionList: Set to
AP_STATUS
.

Example: Checking a Status

Request

{
  "paymentInformation": {
    "paymentType": {
      "name": "bankTransfer",
      "method": {
        "name": "payToPayByBank"
      }
    }
  },
  "processingInformation": {
    "actionList": ["AP_STATUS"]
  }
}

Response to a Successful Request

{
    "processorInformation": {
        "responseCode": "00005"
    },
    "reconciliationId": "KOZX0DMQKX0C",
    "message": "Request was processed successfully.",
    "status": "FUNDED",
    "id": "7544157383456089204805",
    "submitTimeUtc": "2025-08-05T17:42:18Z"
}