BOARDING MERCHANTS

diligence-remarks-controller
- Remarksput
- /api/v1/diligence/remarks/{applicationId}get
application-impl-controller
diligence-controller
- /api/diligenceput
- /api/diligence/{id}get
token-controller
- /tokenpost
- /token/refreshpost
terminal-controller
open-fx-controller
secondary-tax-id-values-controller
- /api/v1/secondaryTaxIDValuesget
ipg-controller
- /api/v1/ipgget
- /api/v1/ipg/merchant/{mid}get
fdpos-controller
- /api/v1/fdpos/products-and-features/{countryCode}get

MAINTENANCE MERCHANTS

Tms Controller
Transaction Charges Controller
TMP Controller
OrdersController
pcf-controller
payment-instructions-controller
merchant-services-controller
merchant-references-controller
merchant-properties-controller
merchant-details-controller
addresses-controller
accounts-controller
account-fees-controller
omnihub-controller
e-commerce-controller
open-fx-controller
fd-pos-maintenance-controller
- /api/v1/maintenance/fdpos/products/{mid}post
- /api/v1/maintenance/fdpos/{mid}/request/{requestId}/terminalsget
clover-controller
- /api/v1/clover/merchant/{mid}/terminal/provisionpost
- /api/v1/clover/merchant/{mid}/terminal/deprovisionpost
internal-log-controller
- /api/v1/audit-logget

ecommerce

Payment
Order
- Perform return or postAuth secondary transactionspost
- Retrieve the state of an orderget
Payment Schedules
Payment URL
Payment Token
Verification
- Verify a payment cardpost
- Verify a payment card or payment tokenpost
Currency Conversion
- Generate dynamic currency conversion transactionspost
Information Lookup
- Card Information Lookuppost
- Account Information Lookuppost

Delete a payment URL

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

Use this to delete a payment link.

Query Params

storeId

string

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

transactionId

string

Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId.

orderId

string

Gateway order identifier as returned in the parameter orderId.

paymentUrlId

string

The ID code from the payment URL.

transactionTime

string

The transaction time in seconds since epoch.

Headers

Content-Type

string

required

Defaults to application/json

Content type.

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

The type of the response.

BadRequest Unauthenticated Unauthorized NotFound GatewayDeclined EndpointDeclined ServerError EndpointCommunicationError UnsupportedMediaType

requestStatus

string

Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.

SUCCESS VALIDATION_FAILED PROCESSING_FAILED FAILURE

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

paymentUrl

string

URL for embedded payment link.

expiration

int64

Time until payment URL expires. Returns EPOCH Seconds

transactionId

string

ID code from the transaction.

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

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

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

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

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

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

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.

Updated over 1 year ago

Create a payment URL

Retrieve the state of payment URL

Did this page help you?

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://cert.api.firstdata.com/gateway/v2/payment-url \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

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

application/json

Updated over 1 year ago

Create a payment URL

Retrieve the state of payment URL

Did this page help you?

BOARDING MERCHANTS
diligence-remarks-controller
/api/v1/diligence/remarks/{applicationId}get
Remarksput
application-impl-controller
/api/v1/application/account-currencyget
/api/v1/application/account-feesget
/api/v1/application/account-recordget
/api/v1/application/account-settlementsget
/api/v1/application/account-typeget
/api/v1/application/acquirer-profileget
/api/v1/application/contractsget
/api/v1/application/data/{countryCode}get
/api/v1/application/dataget
/api/v1/application/hierarchyget
/api/v1/application/mccget
/api/v1/application/merchant-propertiesget
/api/v1/application/optional-detailsget
/api/v1/application/reference-fieldsget
/api/v1/application/servicesget
/api/v1/application/transaction-charges/allget
/api/v1/application/transaction-chargesget
/api/v1/application/{applicationId}get
/api/v1/application/boardpost
/api/v1/application/{applicationId}/boardpost
/api/v1/applicationpost
/api/v1/applicationget
/api/v1/application/{applicationId}put
diligence-controller
/api/diligence/{id}get
/api/diligenceput
token-controller
/token/refreshpost
/tokenpost
terminal-controller
/api/v1/terminal/allTerminalValuesget
/api/v1/terminal/templates/country/{countryCode}get
/api/v1/terminal/save-allpost
open-fx-controller
/api/v1/openfx-margins/application/{applicationId}delete
/api/v1/openfx-margins/application/{applicationId}get
/api/v1/openfx-marginspost
secondary-tax-id-values-controller
/api/v1/secondaryTaxIDValuesget
ipg-controller
/api/v1/ipg/merchant/{mid}get
/api/v1/ipgget
fdpos-controller
/api/v1/fdpos/products-and-features/{countryCode}get

MAINTENANCE MERCHANTS
Tms Controller
/api/v1/terminals/tms/terminal/{terminalId}get
/api/v1/terminals/tms/merchantpost
/api/v1/terminals/tms/terminalpost
/api/v1/terminals/tms/merchant/{merchantId}put
/api/v1/terminals/tms/merchant/{merchantId}get
/api/v1/terminals/tms/merchant/{merchantId}/terminal/{terminalId}delete
/api/v1/terminals/tms/merchant/{merchantId}/terminal/{terminalId}put
Transaction Charges Controller
/api/v1/transactionCharges/deleteFutureTransactions/{mid}delete
/api/v1/transactionCharges/cloneDefaultToIndividual/{mid}post
/api/v1/transactionCharges/expireCharges/{mid}put
/api/v1/transactionCharges/{mid}post
/api/v1/transactionCharges/{mid}put
/api/v1/transactionCharges/{mid}get
TMP Controller
/api/v1/terminals/enquire-terminals/{merchandId}get
/api/v1/terminals/inquiry-status/{referenceNumber}get
/api/v1/terminals/supply-requestget
/api/v1/terminals/ticket-list/{merchandId}get
/api/v1/terminals/change-technology/{merchandId}post
/api/v1/terminals/replacement/{merchandId}post
/api/v1/terminals/supply-request/{merchandId}post
/api/v1/terminals/change-carrier/{merchantId}put
OrdersController
/api/v1/orders/clear-cache-reason-cancellationdelete
/api/v1/orders/inquery-reason-cancellationget
/api/v1/orders/ticket-list/{merchantId}get
/api/v1/orders/cancel-orderpost
/api/v1/orders/reschedulepost
pcf-controller
/api/v1/pcfdelete
/api/v1/pcfpost
/api/v1/pcfput
payment-instructions-controller
/api/v1/omnipay/paymentInstructions/{mid}post
/api/v1/omnipay/paymentInstructions/{mid}get
/api/v1/omnipay/paymentInstructions/expire/{mid}put
merchant-services-controller
/api/v1/omnipay/merchantServices/{mid}post
/api/v1/omnipay/merchantServices/{mid}put
/api/v1/omnipay/merchantServices/{mid}get
merchant-references-controller
/api/v1/omnipay/merchantReferences/{mid}delete
/api/v1/omnipay/merchantReferences/{mid}post
/api/v1/omnipay/merchantReferences/{mid}put
/api/v1/omnipay/merchantReferences/{mid}get
merchant-properties-controller
/api/v1/omnipay/merchantProperties/{mid}delete
/api/v1/omnipay/merchantProperties/{mid}post
/api/v1/omnipay/merchantProperties/{mid}put
/api/v1/omnipay/merchantProperties/{mid}get
merchant-details-controller
/api/v1/omnipay/merchantDetails/{mid}/contractdelete
/api/v1/omnipay/merchantDetails/{mid}/contractpost
/api/v1/omnipay/merchantDetails/{mid}/contractput
/api/v1/omnipay/merchantDetails/{mid}/statusput
/api/v1/omnipay/merchantDetails/{mid}put
/api/v1/omnipay/merchantDetails/{mid}get
addresses-controller
/api/v1/omnipay/addresses/{mid}delete
/api/v1/omnipay/addresses/{mid}post
/api/v1/omnipay/addresses/{mid}put
/api/v1/omnipay/addresses/{mid}get
accounts-controller
/api/v1/omnipay/accounts/{mid}post
/api/v1/omnipay/accounts/{mid}put
/api/v1/omnipay/accounts/{mid}get
account-fees-controller
/api/v1/omnipay/accountFees/{mid}delete
/api/v1/omnipay/accountFees/{mid}post
/api/v1/omnipay/accountFees/{mid}put
/api/v1/omnipay/accountFees/{mid}get
omnihub-controller
/api/v1/omnihub/merchant/{mid}/parameters/last-executionget
/api/v1/omnihub/paymentProcessor/{mid}get
/api/v1/omnihub/paymentProcessor/update/{mid}put
e-commerce-controller
/api/v1/ecommerce/{mid}/{country}post
/api/v1/ecommerce/{mid}/{country}put
/api/v1/ecommerce/{mid}/{country}get
open-fx-controller
/api/v1/openfx-margins/application/{internalMerchantId}delete
/api/v1/openfx-margins/merchant/{internalMerchantId}get
/api/v1/openfx-marginspost
fd-pos-maintenance-controller
/api/v1/maintenance/fdpos/{mid}/request/{requestId}/terminalsget
/api/v1/maintenance/fdpos/products/{mid}post
clover-controller
/api/v1/clover/merchant/{mid}/terminal/deprovisionpost
/api/v1/clover/merchant/{mid}/terminal/provisionpost
internal-log-controller
/api/v1/audit-logget

ecommerce
Payment
Perform update on an existing transactionpatch
Perform a secondary transactionpost
Update a payment and continue processingpatch
Retrieve the state of a transaction.get
Generate a primary transactionpost
Order
Retrieve the state of an orderget
Perform return or postAuth secondary transactionspost
Payment Schedules
Update a gateway payment schedulepatch
Cancel a gateway payment scheduledelete
View a gateway payment scheduleget
Create gateway payment schedulepost
Payment URL
Retrieve the state of payment URLget
Delete a payment URLdelete
Create a payment URLpost
Payment Token
Delete a payment tokendelete
Get payment card details associated with tokenget
Update one or more payment tokenspatch
Create a payment token from a payment cardpost
Verification
Verify a payment card or payment tokenpost
Verify a payment cardpost
Currency Conversion
Generate dynamic currency conversion transactionspost
Information Lookup
Account Information Lookuppost
Card Information Lookuppost

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.

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

500An unexpected internal server error occurred.