Generate a primary transaction

Use this to originate a financial transaction like a sale, preauthorization, or credit.

Body Params

Accepted request types: PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaypalCreditTransaction.

Provides shared fields for all PrimaryTransaction request types. Abstract class, do not use this class directly, use one of its children.

paymentMethod
object

Various payment methods the Gateway supports. Abstract class, do not use this class directly, use one of its children.

storedCredentials
object

Object for sending stored credentials.

settlementSplit
array of objects
length between 1 and 5

Settle with multiple sub-merchants, sale and preAuth only.

settlementSplit
createToken
object

Use this model to create a payment token.

currencyConversion
object

Currency conversion. Abstract class, do not use this class directly, use one of its children: Dcc, DynamicPricing.

authenticationRequest
object

Request authentication of the payment card to verify the cardholder and be eligible for liability shift. An AuthenticationRequest should not be submitted with in the same request as an AuthenticationResult. Abstract class, do not use this class directly, use one of its children.

authenticationResult
object

Submit the result of 3DS authentication managed outside of the gateway. An AuthenticationResult should not be submitted within the same request as an AuthenticationRequest. Abstract class, do not use this class directly, use one of its children.

authOptimization
object

Object for sending Card Account Updater.

boolean
Defaults to false

Indicates if the merchant wants payment account reference number from the network token using endpoint(PaymentAccountReferenceFlag = true).

Headers
string
enum
required
Defaults to application/json

Content type.

Allowed:
string
required

A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

string
required

Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

int64
required

Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

string
required

Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

Responses

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