API Rest
DocsAPI RestRecipesTutorialsHelp

Create gateway payment schedule

post
https://cert.api.firstdata.com/gateway/v2/payment-schedules

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

Body Params

Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.

string
required

Object name of the payment schedules request.

string
length ≤ 20

Store ID number.

date
required

Date of mandate signature.

date

Date of next transaction process attempt.

int32
1 to 999

Number of times the recurring payment will process.

int32
1 to 999

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

string

Invoice number.

string

Purchase order number.

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:
string

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.

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

billing
object

Customer billing information.

shipping
object

Shipping information.

industrySpecificExtensions
object

Industry-specific information.

string

User supplied comments.

paymentMethod
object
required

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

Headers
string
enum
required
Defaults to application/json

Content type.

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

string
required

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

int64
required

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

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

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago