Skip to main content
POST
Process Transaction

Processing Charges Guide

Process payments using stored tokens
PCI Booking retrieves the real card data from the token, constructs a PSP-specific request, sends it to your configured payment gateway, and returns the gateway’s response.
Some payment gateways have additional requirements. Review the gateway-specific guidance before sending your first transaction.

Error Responses

Parameter Constraints

  • OperationType: Must be one of Charge, PreAuth, Capture, Void, Refund, Tokenize.
  • Amount: Required for all operations except Void and Tokenize.
  • GatewayReference: Required for Refund operations.
  • cardToken: Required when the operation needs card data and no GatewayToken is provided. Must be a valid PCI Booking token URI containing a 32-character hex token.
  • credentialsId or PaymentGateway object: One must be provided. If using credentialsId, the credentials must already be stored.

Parameters

Headers

Authorization
string
required
Your API key prefixed with APIKEY. Example: APIKEY your-api-key. See the Authentication guide.

Query String

credentialsId
string
The ID of credentials stored in PCI Booking. When provided, omit the PaymentGateway object from the request body.
certName
string
The name of a client certificate to use for gateway authentication, if required by the gateway.

Request Body

cardToken
string
required
The PCI Booking card token URI, received during tokenization.
OperationType
string
required
The operation to perform. One of: Charge, PreAuth, Capture, Void, Refund, Tokenize.
Amount
number
The transaction amount. Required for all operations except Void and Tokenize.
Currency
string
ISO 4217 currency code (e.g. USD, EUR). Required for all operations except Void and Tokenize.
PaymentGateway
object
The payment gateway name and credentials. Not required if credentialsId is provided.
GatewayReference
string
The transaction ID of a prior operation. Required for Capture (reference the PreAuth), Refund (reference the Charge or Capture), and Void (reference the operation to void).
GatewayToken
string
A token previously generated by the payment gateway. When provided, PCI Booking uses this gateway token instead of the card token for the transaction.
myRef
string
Your own reference for this transaction. Some gateways have specific format requirements. See gateway guidance.
GenerateToken
boolean
default:"false"
For Charge and PreAuth operations, additionally generates a token from the payment gateway. The gateway token is returned in the response.
ThreeDS
boolean
default:"true"
Whether to use 3D Secure authentication for this transaction.
Parameters
object
Gateway-specific parameters as key-value pairs. These are passed through to the payment gateway. See gateway guidance for supported parameters per gateway.

Payer and Order Details

PayerDetails
object
Details about the customer being charged. Some gateways require specific payer fields.
OrderDesc
string
Order description. Used by specific payment gateways. See gateway guidance for details.
IsDigital
boolean
Indicates digital goods. Used by specific gateways (e.g. WorldPay).

Fallback Routing

FallbackUpgs
array
A list of fallback payment gateway accounts. If the primary gateway fails, PCI Booking tries each fallback in order.

Request Example

A Charge operation for $150.00 USD, using inline gateway credentials:
To use stored credentials instead of inline ones, pass the credentialsId query parameter and omit the PaymentGateway object:

Response

The response contains the gateway’s transaction result.

Response Fields

Status
string
The outcome of the operation. See the status table below.
TransactionID
string
PCI Booking’s internal transaction identifier.
AuthorizationCode
string
The authorization code returned by the payment gateway. Only present on successful authorizations and charges.
GatewayReference
string
The gateway’s own transaction reference. Use this value for subsequent Capture, Void, or Refund operations on the same transaction.
GatewayDescription
string
Human-readable message from the payment gateway describing the result.
AcquirerDescription
string
Raw response description from the acquirer/processor.

Operation Statuses

Consider adding business logic based on the CVV retention policy status after a transaction.