Perform action on existing APM transaction

patch

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

Perform an action on an existing APM transaction.

Path Params

transaction-id

string

required

Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId. In case you want to use the merchantTransactionId to query the transaction status use this format: .../payments/merchantTransactionId= This is applicable for other scenarios as well, such as void, refund or other secondary transactions.

Body Params

requestType

string

required

Object name of the action request.

comments

string

Comment for the action.

integrationData

array of objects

Integration data to provide information from the application.

integrationData

consumerData

array of objects

Integration data provided by the payer.

consumerData

merchantParameters

string

To remain compliant the custom fields are not to be used to submit credit card detail or sensitive card holder information, please use the designated fields defined by the Gateway for this purpose.

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

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.

415Format that is not supported by the server for the HTTP method.

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