Perform return or postAuth secondary transactions

post

https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/orders/{order-id}

Use this to perform a subsequent transaction, e.g. postAuth or return using an order ID as a reference.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

order-id

string

required

Gateway order identifier as returned in the parameter orderId.

Body Params

Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction and PreAuthSecondaryTransaction.

Model for secondary financial transactions. Abstract class, do not use this class directly, use one of its children.

requestType

string

required

Object name of the secondary transaction request.

storeId

string

length ≤ 20

An optional outlet ID for clients that support multiple stores in the same developer app.

userId

string

length ≤ 128

This is the store's userID (not store-id) from where the product was purchased.

merchantTransactionId

string

length ≤ 40

The unique merchant transaction ID from the request, if supplied.

comments

string

Comment for the secondary transaction.

order

object

Use this model to provide order related details.

terminalRequestData

object

Terminal request data required for card present transactions.

terminalId

string

length between 6 and 32

Unique identifier for the payment terminal where the transaction takes place.

merchantId

string

length between 6 and 32

Unique identifier for the merchant conducting the transaction.

transactionAmount

object

required

Amount of the transaction.

transactionOrigin

string

enum

The source of the transaction. The possible values are ECOM (if the order was received via email or Internet), MOTO (mail order, telephone order), MAIL, PHONE and RETAIL (face to face).

Allowed:

splitShipment

object

Split-shipment related information, in order to reuse the same authorization.

softDescriptor

object

Identifying information about a merchant which appears on buyer's credit/debit card statements.

parDataRequested

boolean

Defaults to false

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

currencyConversion

object

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

Headers

Content-Type

string

enum

required

Defaults to application/json

Content type.

Allowed:

Client-Request-Id

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.

Api-Key

string

required

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

Timestamp

int64

required

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

Message-Signature

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

200Success response.

400The request cannot be validated.

401The request cannot be authenticated or was submitted with the wrong credentials.

403The request was unauthorized.

404The requested resource doesn't exist.

409The attempted action is not valid according to gateway rules. For example, the merchant is not set-up or the order already exists.

422The processor declined the transaction.

500An unexpected internal server error occurred.

502There was a problem communicating with the endpoint.

API Products

Point of Sale

Developer

Resources