HomeGuideMethod ReferenceAssess YourselfRequest Sandbox Account
Method Reference
Ask For AssistanceLogin

Process Payment Gateway Transaction Using Full Token

post
https://service.pcibooking.net/api/paymentGateway

This request will send one of the approved operations to the payment gateway for processing.
We recommend that you first review the guide for this method.

Operation status from the payment gateway

An operation may have one of the following statuses:

  • Accepted: The payment gateway accepted the request.

  • Success: The operation was successful.

  • Rejected: The operation was rejected by the payment gateway.
    The response will contain the payment gateway description and the acquirer's bank description.

  • TemporaryFailure: The process has failed. The merchant can retry.

  • FatalFailure: The process has failed.

📘

Unique Requirements Per Payment Gateway

Some of the payment gateways have additional requirements in order to send a charge request through their service. Please review the list of unique requirements for each payment gateway.

📘

Checking on CVV retention policy status

We recommend adding business logic based on the current status of the CVV retention policy following a token replacement request.

Query Params
string

An optional parameter to provide the ID given to the credentials for the payment gateway when they were stored in PCI Booking
Please note: If the 'credentialsId' parameter is provided, then the 'PaymentGateway' object does not need to be provided.

string

An optional parameter to specify the name of the clientcertificate to use for Authentication if one is needed.
Please note, prior to sending the request to the UPG, you will need to follow this guide to upload the client certificate to our portal.

Body Params
PaymentGateway
object

A custom object specifying the name of the payment gateway to use and the credentials for that payment gateway.
Please note: If the 'credentialsId' parameter is provided, then the 'PaymentGateway' object does not need to be provided.

string

The operation that you would like to perform. Possible values are PreAuth,Capture,Charge,Refund, Void and Tokenize. For operations that refer to previous operations, like "Capture" and "Refund", enter the gateway reference (transaction ID) for the identification of the original transaction.

string

The card token from PCI Booking. The card token is received in tokenization process.

string

A reference field for this transaction.

float

The amount of the transaction.

string

The currency of the transaction. Based on ISO 4217.

string

When requesting to cancel or void a prior transaction (such as charge or preauthorization), this field should hold the transactionID for that prior operation.

boolean

This field is only used with transactions for the payment gateway WorldPay.

PayerDetails
object

Details regarding the customer being charged.

string

This field is only used with transactions for the payment gateways Wirecard and Zeamster. Please read further explanation below.

boolean

This field is only used with the payment gateway Authorize.net

boolean
Defaults to false

Used only in PreAuth and Charge operations to additionally generate a token from the payment gateway.

Headers
string
required

The authorization mechanism for this method is with the API key in the format of APIKEY {value}.
For example, APIKEY bd3ce883352e42539a2b7644f72e6311.

Responses

Updated over 2 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago