Pay API™
About Pay API™
Pay API is Datacap's payment API built around RESTful standards. These include standard HTTP methods (POST/GET/PUT), content types (JSON/XML/form encoded), and a resource-oriented architecture. It's a straightforward integration to ecommerce credit, ACH, gift and other card-not-present payments.
URL
Type | URL |
|---|---|
Certification | https://pay-cert.dcap.com/{version}/ |
Production | https://pay.dcap.com/{version}/ |
Transactions
Credit Transactions
Operation | HTTP Method | URL |
|---|---|---|
Sale | POST | /credit/sale |
Void Sale | POST | /credit/sale/{RefNo}/void |
Adjust | PUT | /credit/sale/{RefNo} |
Return | POST | /credit/return |
Void Return | POST | /credit/return/{RefNo}/void |
PreAuth | POST | /credit/preauth |
Capture | PUT | /credit/preauth/{RefNo} |
Increment | PUT | /credit/preauth/incrementalauth/{RefNo} |
PartialReversal | PUT | /credit/preauth/partialreversal/{RefNo} |
Void Auth | POST | /credit/preauth/{RefNo}/void |
Auth Only | POST | /credit/authonly |
Transaction Detail | GET | /credit/{RefNo} |
Card Lookup | POST | /credit/cardlookup |
ACH Transactions
Operation | HTTP Method | URL |
|---|---|---|
Authorize | POST | /ach/authorize |
Return | POST | /ach/return/{RefNo} |
Void | POST | /ach/authorize/{RefNo}/void |
Payout | POST | /ach/payout |
FSA Transactions
Operation | HTTP Method | URL |
|---|---|---|
FSA Sale | POST | credit/fsa/sale |
Void FSA Sale | POST | credit/fsa/sale/{RefNo}/void |
Stored Value Transactions
Operation | HTTP Method | URL |
|---|---|---|
Sale | POST | /storedvalue/sale |
Void Sale | POST | /storedvalue/sale/{RefNo}/void |
Return | POST | /storedvalue/return |
Void Return | POST | /storedvalue/return/{RefNo}/void |
Reload | POST | /storedvalue/reload |
Void Reload | POST | /storedvalue/reload/{RefNo}/void |
Issue | POST | /storedvalue/issue |
Void Issue | POST | /storedvalue/issue/{RefNo}/void |
Balance | POST | /storedvalue/balance |
Create | POST | /storedvalue/create |
Set | POST | /storedvalue/set |
Cash Out | POST | /storedvalue/cashout |
Transaction Detail | GET | /storedvalue/{RefNo} |
Administration Requests
Operation | HTTP Method | URL |
|---|---|---|
AcquireInitialApiKey | POST | admin/AcquireInitialApiKey |
AcquireApiKey | POST | admin/AcquireApiKey |
Batch Summary | GET | /admin/batchsummary |
Batch Close | POST | /admin/batchclose |
Success Responses
- 200 OK Approved Transaction
- 402 PAYMENT REQUIRED Declined Transaction
Failure Responses
- 400 BAD REQUEST Invalid Transaction Requests
- 401 UNAUTHORIZED Unauthorized Transaction
- 404 NOT FOUND Resource Not Found
eCommerce Integration
A typical eCommerce integration with Datacap consists of the following:
- Client side tokenization utilizing one or more of our tokenization frameworks.
- An otu (one-time-use) token is created that is good for 15 minutes.
- Payment processing utilizing one of our gateway platforms.
- An Auth Only transaction is sent to validate the account information represented by the one-time-use token.
- A card token is returned with any successful transaction and is good through the expiration date of the account it represents.
Request Full Access to Pay API
Get started: Request developer credentials for free access to every product's integration guide.