API Rest
DocsAPI RestRecipesTutorialsHelp

Generate a primary transaction

post
http://api.fiserv.com/payments/v2/payments

Use this to originate a financial transaction like a Sale, Refund, Void, Reversal, Preauthorization, Incremental or Completion.


IN DEVELOPMENT
Body Params

Payload for initiating a payment request.

string
enum
required

Object name of the primary transaction request.


A "Transaction Type" or "Financial Transaction Type" refers to the
classification of a transaction based on its nature or purpose in the
context of financial activities.


Different types of financial transactions serve various functions and are
categorized based on their characteristics and the parties involved.

Allowed:
boolean

Parameter used in electronic payment processing systems to indicate whether a transaction should be captured for settlement.

Values:

  • true - For Sale, Refund, Completion;
  • false - For Pre-Authorization and Incremental.
string
required
length ≤ 6

Refers to the time at which a financial transaction occurs within a specific local time zone.
It represents the exact moment when the transaction is initiated, processed, or recorded by the relevant financial institution or payment network.

string
required
length ≤ 6

Refers to the date on which a financial transaction occurs in the local time zone where the transaction is initiated or conducted.
It represents the specific calendar date when the transaction is processed or recorded by the relevant financial institution or payment network.
Format YYMMDD

transactionAmount
object

Amount of the transaction.

order
object

Use this model to provide order related details.

paymentMethod
object

Payment method containing payment card information.

string
required
length between 1 and 8

Unique identifier assigned to a specific terminal within a merchant's establishment.
It is used to identify and differentiate individual terminals within a merchant's network and is essential for various functions, including transaction processing, reporting, and troubleshooting.

terminalRequestData
object

Terminal request data required for card present transactions.

device
object
required

Terminal Capabilities.

processor
object

Model for processor data.

string
length ≥ 1

A PIN block refers to a data element used in secure transmission of Personal Identification Numbers (PINs) in financial transactions, particularly in the context of debit and credit card transactions.

It is an encrypted form of the PIN that enhances security during PIN verification processes.

string
length ≤ 128

Key Sequence to determine the Active PIN key used on the transaction.


Source should echo the key Sequence in the request message for applicable transactions.

string
required
length between 1 and 6

A number used for matching responses to messages.
This number must be set by a message sender and echoed by a message receiver.
It is used for matching responses to original messages and is not intended to remain the same throughout the life of a transaction (e.g., a reversal cannot have the same number as the original transaction).

currencyConversion
object

Dynamic Currency Conversion (DCC) gives a merchant the ability to offer
a favourable conversion rate for certain foreign Visa and MasterCard
transactions to their customers.

walletPaymentMethod
object

Wallet payment method information.

categoryCode
object
string
enum

Transaction Sub Category Code (TCC) is a classification code used to
categorize transaction sub type and migth be requires transaction
addional information.

Values:

  • "01" - Advance Deposit

  • "02" - After Departure

  • "03" - No Show Charge

Allowed:
Headers
string
required

Indicates the media type of the request body.

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

The Message Authentication Value (MAC) is optional and only required for Card Present transactions or those from Terminals. Format: ;;;[;][;<key version>]. Example derivation algorithms: DUKPT2009, AESDUKPT128ECB. Example MAC algorithms: RetailSHA256MAC, SHA256CMACwithAES128.

string
required

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

int64
required

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

Responses

Updated 3 months ago

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

Updated 3 months ago