Update a gateway payment schedule

patch

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

Use this to update a payment schedule managed by the gateway.

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

requestType

string

required

Object name of the payment schedules patch request.

storeId

string

length ≤ 20

Store ID number.

userId

string

length ≤ 128

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

nextAttemptDate

date

Date of next transaction process attempt.

numberOfPayments

int32

1 to 999

Number of times the recurring payment will process.

maximumFailures

int32

1 to 999

Number of failures that can be encountered before re-tries cease.

invoiceNumber

string

length ≤ 48

Invoice number.

purchaseOrderNumber

string

length ≤ 128

Purchase order number.

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:

dynamicMerchantName

string

length ≤ 100

Dynamic merchant name for the cardholder's statement.

frequency

object

required

How often payments are sent.

transactionAmount

object

required

Amount of the transaction.

clientLocale

object

Country and language of client.

orderId

string

length ≤ 100

Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).

billing

object

Customer billing information.

shipping

object

Shipping information.

industrySpecificExtensions

object

Industry-specific information.

comments

string

length ≤ 1024

User supplied comments.

paymentMethod

object

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

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 was unauthorized.

404The requested resource doesn't exist.

409There was a problem communicating with the endpoint.

422There was a problem communicating with the endpoint.

500An unexpected internal server error occurred.