Manage payments

On this page:

• Query a payment
• Reverse an authorization
• Capture an authorization
• Refund a captured payment

Query a payment

You can query the state of a payment by sending a GET request to the REST API.

Example request

Send a GET request to the transactions endpoint.

GET https://apitest.cybersource.com/tss/v2/transactions/{id}

Response

A successful request returns an HTTP code 200 along with the following parameters:

Reverse an authorization

You can use the authorization reversal service to reverse an unnecessary or undesired authorization.

A successful authorization reversal releases the hold that the authorization placed on your customer's payment card funds.

You can only reverse an authorization that has not been captured and settled. Each issuing bank has its own rules for deciding whether a full authorization reversal succeeds or fails.

If the authorization has been captured, we recommend you refund the payment.

Authorization reversal example request

POST the authorization information to the REST API Reversals resource.

POST https://apitest.cybersource.com/pts/v2/payments/{id}/reversals

Authorization reversal request body:

{
  "reversalInformation": {
    "amountDetails": {
      "totalAmount": "102.21",
      "currency": "GBP"
    }
  }
}

Response

A successful request returns an HTTP code 200 along with the following parameters:

Capture an authorization

When you are ready to fulfill a customer's order and transfer funds from your customer's bank to your bank, capture the authorization for that order.

If you can fulfill only part of a customer's order, do not capture the full amount of the authorization. Capture only the cost of the items that you can ship. When you ship the remaining items, request a new authorization, then capture the new authorization.

Unlike authorizations, a capture does not happen in real time. All of the capture requests for a day are placed in a batch file and sent to the processor.

In most cases, the batch is settled at night. It usually takes two to four days for your acquiring bank to deposit funds in your merchant bank account.

Capture authorization example request

POST the authorization information to the REST API Capture resource.

POST https://apitest.cybersource.com/pts/v2/payments/{id}/captures

Authorization capture request body:

{
   "orderInformation": {
    "amountDetails": {
      "totalAmount": "102.21",
      "currency": "GBP"
    }
  }
}

Response

A successful request returns an HTTP code 201 along with the following parameters:

Refund a captured payment

A refund is linked to a capture in the payment system. You can request multiple refunds against a single capture.

When your request for a refund is successful, the issuing bank for the payment card takes money out of your merchant bank account and returns it to your customer.

It usually takes two to four days for your acquiring bank to transfer funds from your merchant bank account.

Refund example request

POST the value from the id field of the capture response to your REST API refund resource.

POST https://apitest.cybersource.com/pts/v2/payments/{id}/refunds

Refund request body:

{
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "10",
      "currency": "GBP"
    }
  }
}

Response

A successful request returns an HTTP code 201 along with the following parameters: