API Rest
DocsAPI RestRecipesTutorialsHelp

Create a payment URL

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

Use this to generate a payment link.

Body Params

Accepted request type: PaymentUrlRequest.

string
length ≤ 20

An optional Outlet ID for clients that support multiple stores in the same developer app.

clientLocale
object

Country and language of client.

transactionAmount
object
required

Amount of the transaction.

string
enum
required

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

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

URL for notifying merchant of payment result.

int64

Expiration time of the payment URL in seconds in the timestamp format.

boolean

If 3D secure should be applied.

string

Dynamic merchant name for the cardholder's statement.

string

Invoice number.

string

Purchase order number.

string
length ≤ 255

The text to be displayed to the payer on the hosted payment page.

string

IPv4 or IPv6 network address.

revolvingOptions
object

Indicates the options for revolving payment.

installmentOptions
object

Indicates that the total sum payable is divided for payment at successive fixed times.

recurringDetails
object

Indicates the options for revolving payment.

basket
object

Indicates basket of items.

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