Update a gateway payment schedule

patch https://cert.api.firstdata.com/gateway/v2/payment-schedules/{order-id}

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

Path Params

order-id

string

required

Gateway order identifier as returned in the parameter orderId.

Body Params

PaymentMethodPaymentSchedulesPatchRequest

ReferencedOrderPaymentSchedulesPatchRequest

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

Response body

object

clientRequestId

string

Echoes back the value in the request header for tracking.

apiTraceId

string

Request identifier in API, can be used to request logs from the support team.

responseType

string

enum

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

requestStatus

string

enum

Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.

SUCCESS VALIDATION_FAILED PROCESSING_FAILED FAILURE DECLINED

orderId

string

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

state

string

enum

State of the recurring payment.

Installed Inactivated Cancelled

transactionResponse

object

Contains apiTraceId and clientRequestId shared in all response types.

clientRequestId

string

Echoes back the value in the request header for tracking.

apiTraceId

string

Request identifier in API, can be used to request logs from the support team.

responseType

string

enum

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

ipgTransactionId

string

The response transaction ID.

orderId

string

transactionType

string

enum

Type of transaction to perform. Primary transaction types in requests include 'SALE', 'PREAUTH', 'CREDIT' and 'FORCED_TICKET'.

SALE PREAUTH CREDIT FORCED_TICKET VOID RETURN POSTAUTH PAYER_AUTH

paymentToken

object

Use this model to create a payment token.

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).

ECOM MOTO MAIL PHONE RETAIL

paymentMethodDetails

object

Provides details of the payment method used.

country

string

Country of the card issuer.

terminalId

string

The terminal that is processing the transaction.

merchantId

string

length ≤ 30

The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint.

merchantTransactionId

string

length ≤ 40

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

transactionTime

int64

The transaction time in seconds since epoch.

approvedAmount

object

Amount of the transaction.

transactionAmount

object

Amount of the transaction.

transactionStatus

string

enum

This field is Deprecated. Point to 'transactionResult'.

APPROVED WAITING PARTIAL VALIDATION_FAILED PROCESSING_FAILED DECLINED

transactionResult

string

enum

This is the result of the operation, unless transaction status that represent financial status of the transaction, this fields helps us to understand if the operation is successfully executed

APPROVED DECLINED FAILED WAITING PARTIAL FRAUD

approvalCode

string

Shows the transaction approvalcode.

errorMessage

string

Shows the transaction errorMessage.

transactionState

string

enum

Shows the state of the current transaction.

AUTHORIZED CAPTURED DECLINED CHECKED COMPLETED_GET INITIALIZED PENDING READY TEMPLATE SETTLED VOIDED WAITING

paymentAccountReferenceNumber

string

length ≤ 30

Payment Account Reference Number from response, if supplied.

secure3dResponse

object

Contains 3DSecure response code.

standinResponseDetails

object

Contains Standin response details.

redirectURL

string

The endpoint redirection URL.

authenticationResponse

object

Encapsulates 3DS authentication details in transaction responses.

schemeTransactionId

string

length ≤ 40

The transaction ID received from schemes for the initial transaction of card on file flows.

processor

object

Model for processor data.

additionalDetails

object

Additional transaction details for transaction response.

accountUpdaterResponse

object

Details related to updated account information.

currencyConversionResponse

object

Currency Conversion Response.

requiredActions

object

Provides details which actions need to be performed to fulfill requirements of integration data.

networkToken

object

Network Token Model

Language

Credentials

Header

URL


xxxxxxxxxx
20
1
curl --request PATCH \
2
     --url https://cert.api.firstdata.com/gateway/v2/payment-schedules/order-id \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json' \
5
     --data '
6
{
7
  "frequency": {
8
    "unit": "DAY"
9
  },
10
  "paymentMethod": {
11
    "paymentFacilitator": {
12
      "subMerchantData": {
13
        "document": {
14
          "type": "NATIONAL_IDENTITY"
15
        }
16
      }
17
    }
18
  }
19
}
20
'

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