Process Payment Gateway Transaction Using Full Card Details

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.

This method is deprecated and should not be used. If you are PCI compliant yourself and have the card details and just need to charge the card, please consider using our latest product offering Orchestra.

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.

Query Params
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
required

Identifier of the payment gateway to use.

string

The operation that you would like to perform. Possible values are PreAuth,Capture,Charge,Refund and Void. 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

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.

PayerDetails
object

Details regarding the customer being charged.

boolean

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

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

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

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