Create a payment link

post

https://prod.emea.api.fiservapps.com/sandbox/exp/v1/payment-links

Create a payment link by passing the required parameters. This link can then be passed on to the end consumer to direct them to a checkout page. Redirect URLs are not applicable for Payment Links. Do not use this field when creating Payment Link requests. The payment result is displayed directly on the checkout page.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Note for testing
When testing via the Fiserv developer portal you do not need to provide values for the following headers:
Message-Signature
Client-Request-Id
Timestamp

Body Params

storeId

string

required

length ≤ 20

Unique identifier for the respective store

merchantTransactionId

string | null

You can use this parameter to tag a unique identifier to this transaction for future reference.

transactionOrigin

string

enum

Defaults to ECOM

This parameter is used to flag the transaction source correctly. The possible values are ECOM (if the order was recieved from online shop), MAIL & PHONE.

Allowed:

transactionType

string

enum

required

You can use this parameter to specify the type of transaction you want to perform. Allowed values are: SALE, PRE-AUTH, ZERO-AUTH

Allowed:

transactionAmount

object

required

order

object

Object contais order related details.

checkoutSettings

object

paymentMethodDetails

object | null

Object contains payment method details.

paymentLinkDetails

object

Headers

Client-Request-Id

uuid

required

A client-generated ID for message signature creation, unique per request.

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.

Timestamp

string

required

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

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Note for testing

201Payment link is successfully created along with payment link id.

400Bad request

401Unauthorised

403Forbidden

404Not found

429Too many requests

500Internal server error

API Products

Point of Sale

Developer

Resources

📘
Note for testing