Create gateway payment schedule

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

requestStatus

string

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

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

ipgTransactionId

string

The response transaction ID.

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

transactionType

string

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 DISBURSEMENT

paymentToken

object

Use this model to create a payment token.

transactionOrigin

string

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

This field is Deprecated. Point to 'transactionResult'.

APPROVED WAITING PARTIAL VALIDATION_FAILED PROCESSING_FAILED DECLINED

transactionResult

string

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

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.

plannedDueDate

string

Capture PlannedDueDate field sent for SEPA transactions.

networkToken

object

Network Token Model

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

requestStatus

string

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

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

ipgTransactionId

string

The response transaction ID.

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

transactionType

string

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 DISBURSEMENT

paymentToken

object

Use this model to create a payment token.

transactionOrigin

string

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

This field is Deprecated. Point to 'transactionResult'.

APPROVED WAITING PARTIAL VALIDATION_FAILED PROCESSING_FAILED DECLINED

transactionResult

string

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

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.

plannedDueDate

string

Capture PlannedDueDate field sent for SEPA transactions.

networkToken

object

Network Token Model

error

object

Error information.

code

string

Uniquely identifies an error condition. Client applications need to read and handle errors based on this.

message

string

A generic description of the error condition.

details

array of objects

Detailed information about message format errors.

details

object

field

string

The property or attribute associated with the error.

message

string

Information specific to a property or attribute.

declineReasonCode

string

Information about the decline reason.

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

requestStatus

string

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

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

ipgTransactionId

string

The response transaction ID.

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

transactionType

string

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 DISBURSEMENT

paymentToken

object

Use this model to create a payment token.

transactionOrigin

string

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

This field is Deprecated. Point to 'transactionResult'.

APPROVED WAITING PARTIAL VALIDATION_FAILED PROCESSING_FAILED DECLINED

transactionResult

string

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

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.

plannedDueDate

string

Capture PlannedDueDate field sent for SEPA transactions.

networkToken

object

Network Token Model

error

object

Error information.

code

string

Uniquely identifies an error condition. Client applications need to read and handle errors based on this.

message

string

A generic description of the error condition.

details

array of objects

Detailed information about message format errors.

details

object

field

string

The property or attribute associated with the error.

message

string

Information specific to a property or attribute.

declineReasonCode

string

Information about the decline reason.

200Success response.

400The request cannot be validated.

401The request was unauthorized.

404The requested resource doesn't exist.

409The attempted action is not valid according to gateway rules.

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

422The endpoint declined the transaction.

500An unexpected internal server error occurred.