Cybersource payments
offers seamless payment processing through integration with Cybersource payment system, a global supplier of merchant services and payment gateways. This empowers businesses with a robust and secure payment processing solution, enabling them to effortlessly manage transactions and refunds using the readily available Cybersource .
Configuration
The following lists important configuration properties that form the cornerstone of establishing a reliable and secure connection with Cybersource:
- Merchant Id
- Your merchant account in the Cybersource system is uniquely identified by the Cybersource Merchant ID. This ID is given to you when creating an account with Cybersource.
- Secret Key
- The Cybersource payment gateway and your website communicate securely thanks to a shared secret called the Transaction Key, or Cybersource Secret Key. It checks the integrity of communications and creates authentication tokens.
- Api Key
- The website is permitted to communicate with the Cybersource API through the use of the Cybersource API Key, an access key. The communication between your website and the Cybersource servers is safe and authenticated thanks to this key.
- Hostname
- Cybersource API The endpoint URL for the Cybersource API is specified by the hostname. It ascertains the address to which the website submits API queries for handling transactions and other tasks pertaining to payments.
- Solution Id
- The type of integration or solution being utilized is specified by the Cybersource Solution ID. Cybersource uses it to route transactions and apply the proper parameters according to the kind of integration.
Technical specifications
Cybersource leverages Tokenization capabilities offered by Cybersource to improve payment security and expedite recurring transactions. Tokenization lowers the possibility of data breaches by substituting a unique token for sensitive payment information. For more information on Tokenization, see Payment tokenization overview.
The table below showcases all the actions implemented by the to facilitate seamless transaction processing:
| Action | Description | Where the Action is triggered |
|---|---|---|
| create-payment-token |
The When a customer provides their payment details during checkout, sends these details to Cybersource, which generates a unique token representing the payment information and returns. This ensures that Cybersource securely stores the actual payment details while HCL only retains the token. |
The add payment instruction operation
calls the
create-payment-token extension point to
create the payment token. |
| update-payment-token | The update-payment-token API endpoint allows
you to update the payment details associated with a token. This
can be useful if a customer updates their payment information
(For example, changes their credit card number, expiry month,
expiry year, etc.) and you need to reflect those changes in the
tokenized data stored by Cybersource |
The update payment instruction operation
or the
update checkout profile operation
calls the
update-payment-token extension point to
update the payment token. |
| remove-payment-token | The remove-payment-token API endpoint
deletes a payment token. This may be necessary if a customer
deletes their payment information from their account or if you
want to revoke access to stored payment details for security
reasons. |
The delete payment instruction operation
calls
the remove-payment-token extension point to
remove the payment token. |
| fetch-payment-token | The fetch-payment-token API endpoint
retrieves payment token details based on a provided token
identifier. This endpoint allows your website to retrieve
tokenized payment information stored by Cybersource for a
specific customer or transaction. |
The get payment instruction operation
calls
the fetch-payment-token extension point to
fetch the tokenized CC details. |
| approve-payment | The approve-payment API endpoint authorizes
a payment transaction. When a customer submits an order and
selects a payment method, sends a request to
Cybersource's /pts/v2/payments endpoint to
obtain authorization for the transaction. |
The checkout cart operation
calls the
approve-payment extension point to
authorize payment. |
| deposit-payment | The deposit-payment API endpoint initiates
the deposit of funds into a merchant account after a successful
payment transaction. Once a payment transaction has been
approved and authorized, the website sends a
request to
Cybersource's/pts/v2/payments/{approvedPayment_id}/captures
endpoint to transfer the funds from the customer's payment
method to a merchant account. |
The scheduler job ReleaseShipConfirm to
process deposit of funds into a merchant account calls
deposit-payment extension point to process
the deposit transaction. |
| reverse-approval | The reverse-approval API endpoint allows the
reverse approval of a payment transaction that has not yet been
settled. If a customer cancels an order or if there is an issue
with the payment transaction, sends a request to Cybersource's
/pts/v2/payments/{approvedPayment_id}/reversals
endpoint to reverse the authorization and release any reserved
funds. |
The appeasement or RMA process calls
reverse-approval extension point to reverse
the approval transaction. |
| credit-payment | The credit-payment API endpoint initiates a
refund or credit for a previously authorized payment
transaction. If a customer requests a refund for a returned item
or if there is a need to issue a credit for any other reason,
sends a request to Cybersource's
/pts/v2/captures/{capturedPayment_id}/refunds
endpoint to process the refund or credit transaction. |
The appeasement or RMA process initiates a refund call to
credit-payment extension point for
processing credit payment transaction. |