Availability of certain integration methods depend on merchant’s domicile. Click here for details.

Make Payments

POST

Credit Card Payments

/transactions

Use this method to submit payments credit and debit cards. Supported transaction types are 'authorize', 'purchase' and ‘recurring’.

POST

Capture or Reverse a Payment

/transactions/{id}

Use this method to 'capture' or 'void' an authorization or to 'refund' a charge.

POST

Split-Shipment

/transactions/{id}

Use this method for 'Subscriptions' or 'Split Shipments' using a previously authorized transaction. Note: This feature is limited to Apple pay only for now. You can submit transactions in an incremental manner upto a limit of 200% of the initial authorization value. Example: If the initial transaction amount is for $100, additional multiple transactions can be submitted upto another $100.
Use this method to submit timeout, reversal for credit and debit card payments. Supported transaction types are 'authorize' & 'purchase'. Note for US domiciled Merchants: This API is available only in production. Do not attempt this on Sandbox.

POST

PayPal™ Transactions

/transactions

Use this method for PayPal™ transactions. Supported transaction types are 'authorize', 'purchase' & 'order'.

POST

eCheck Purchase

/transactions

Use this method to do transactions via the Telecheck® service. Supports only manual entry of routing and account. Requires First Data Acquiring Account. Supported transaction is Purchase. For ACH token and instant DDA validation, look at the ConnectPay℠ – ACH on File solution section on the /apis page.

POST

Reverse eCheck

/transactions/{id}

Use this method to do transactions via the Telecheck® service. Supported transactions are Void, Tagged Void and Tagged Refund.

POST

German Direct Debit

/transactions

Use this method to submit payments for German Direct Debit. Supported transaction types are 'credit' & 'purchase'.

POST

Use this method to 'void' an authorization or to 'refund' a charge.

POST

DCC/Dynamic Pricing Lookup

/transactions/exchange_rate

Use this method to get local currency, local currency amount, exchange rate, the source of the exchange rate and margin.

POST

Use this method to submit DCC or Dynamic Pricing payments. Supported transaction type is 'purchase'.

POST

Use this method to perform Fraud flex transactions and obtain recommendation codes and fraud scores. Supported transaction types are - 'authorize_score', 'purchase_score' & 'score_only'.

Token Based Transactions

POST

Use this method for Token based 3DS transactions . All tokens (Type="FDToken") are valid for "Multi-Use". Supported transaction types are 'authorize' & 'purchase'.

POST

3DS Integration

/transactions/thirdparty

Use this method to perform 3DS Integration in conjunction with our third party provider-Cardinal Commerce for Credit Card/Token based transaction, and obtain 3DS payload, CAVV, XID, etc and perform Authorize/Purchase 3DS transactions.

GET

Tokenize Credit Cards

/securitytokens

Use this method to create tokens (Type = “FDToken”) with a simple HTTP GET request. This works with all the integration methods. Note: US merchants will receive Transarmor® tokens and EU merchants will receive Datavault tokens. Tokens are valid for multiple uses.

POST

Token Based Payments

/transactions

Use this method for Token based transactions . All tokens (Type="FDToken") are valid for "Multi-Use". Supported transaction types are 'authorize', 'purchase' & 'recurring'.

3DS Transactions

POST

Apple Pay® Transactions

/transactions

Use this method to do transactions using cryptogram which is supported by Apple Pay® mobile payments solution. Supported transaction types are - 'authorize' & 'purchase'.

POST

Use this method to do transactions using cryptogram which is supported by Android Pay™ payment service. Supported transaction types are - 'authorize' & 'purchase'.

POST

3D Secure Transaction

/transactions

Use this method to make 3DS Transaction that requires a 3D Secure cryptogram (value of CAVV).

Gift Card Transactions

POST

Gift Card Purchase

/transactions

Use this method for ValueLink® gift card transactions. Supported transactions are Purchase, Activation, Cash-out, and Reload.

POST

Gift Card Additional

/transactions

Use this method for ValueLink® gift card transactions. Supported transactions are Deactivation, Partial Purchase and Balance Inquiry.

POST

Reverse Gift Card

/transactions/{id}

Use this method for ValueLink® gift card transactions. Supported transactions are Void, Refund, Tagged Void and Tagged Refund.

ConnectPay℠ – ACH on File solution

POST

Establish

/ach/establish

Use this method to retrieve information to pass to PayWithMyBank in order to render the view presenting the list of the banks.

POST

Validate / PayWithMyBank

/ach/validate

Use this method to validate and enrich information coming from PayWithMyBank after particular bank/account is selected. This call is necessary before PayWithMyBank enrollment call.

POST

Enrollment / PayWithMyBank

/ach/consumer/enrollment/pwmb

Use this method to perform enrollment of your account using information from PayWithMyBank validation call. This creates “token” which is a number that identifies your account information and can be used to make transactions.

POST

Enrollment / Regular

/ach/consumer/enrollment

Use this method to perform enrollment of your account using account and personal information directly (without going through PayWithMyBank). This information have to include things like account/routing number, first/last name, address, etc. This also creates “token”, but usually requires further validation using BAA (micro-deposit validation) call.

POST

Enrollment / BAA

/ach/consumer/enrollment/baa

Use this method to validate micro deposits for the regular enrollment. This is not necessary for PayWithMyBank enrollment.

PUT

Enrollment / Update

/ach/consumer/enrollment

Use this method to update your enrollment information (e.g. first/last name, address, etc.)

POST

Enrollment / Close

/ach/consumer/enrollment/close

Use this method to close/delete your enrollment id. After this call is made your enrollment id is no longer usable for transactions.

POST

Make ACH Payments

/transactions

Use this method to submit payments. Supported transaction types are 'authorize' and ‘purchase’.

POST

Use this method to 'capture' or 'void' an authorization or to 'refund' a charge.

Reporting

GET

Partner Reporting API

/transactions

Use our powerful query engine to retrieve payment records. Supports complex filtering, sorting, pagination and more. This is exclusively for Third Party Partners and applicable for a live environment only.

Event Notifications

GET

Call this method to get workflow and boarding status updates. Click on the method for supported event types listed under resource summary section. The response is a list of json objects specific to the event type query.

GET

Get Event by ID

/events/{id}

Get information for a specific event given an event id.