Developers
Integrate in a format you already know
Sureway accepts the API format of a gateway your platform already supports. If you have a connector for that format, the requests and responses below will look familiar.
Example
A sample charge
A rebill, a refund and a void sent to Sureway. Field names and response codes follow the gateway format, so your connector parses the answer as it does today.
POST https://[api-endpoint]/api/transact
Content-Type: application/x-www-form-urlencoded
type=sale
security_key=YOUR_API_KEY
amount=49.00
currency=USD
orderid=SUB-10482-R7
ccnumber=4111111111111111
ccexp=1228
first_name=Jordan
last_name=Lee
address1=200 Main St
zip=94107
initiated_by=merchant
stored_credential_indicator=used
billing_method=recurringresponse=1
responsetext=SUCCESS
authcode=123456
transactionid=10293847561
avsresponse=Y
cvvresponse=M
orderid=SUB-10482-R7
type=sale
response_code=100Example values only.
Scope
Accepted operations
Operationsale
- Status
- Accepted
- Notes
- Authorize and capture in one call. The main path for first charges and rebills.
Operationrefund
- Status
- Accepted
- Notes
- Against the Sureway transaction ID, full or partial.
Operationvoid
- Status
- Accepted
- Notes
- Before the batch settles.
Operationauth and capture
- Status
- Planned
- Notes
- Separate authorization and capture.
OperationReporting and queries
- Status
- Not accepted
- Notes
- Each response carries the full result and transaction ID.
OperationFunding and settlement
- Status
- Not applicable
- Notes
- Funds settle to the merchant through their acquiring bank.
OperationRecurring schedules
- Status
- Not offered
- Notes
- Your platform runs the billing schedule.
An operation outside this list returns a not-supported response in the format's own error style.
Steps
Integration outline
- 1Add a connector in the supported gateway format, or reuse the one you have.
- 2Add Sureway to your gateway list with its credential fields.
- 3Get sandbox credentials from your Sureway contact.
- 4Run the certification scenarios for the accepted operations.
- 5Go live merchant by merchant, as each one chooses Sureway.
Test credentials and a test environment are arranged with your Sureway contact during scoping.
Documents
Documentation
- OverviewWhat Sureway is, how a charge works, and what your platform keeps.Download PDF4 pages · 442 KB
- Integration guide for platform teamsWhat your team builds, what Sureway handles, and how certification works.Download PDF6 pages · 584 KB
- Certification and go-live checklistThe scenarios a connector passes before a merchant goes live.Download PDF3 pages · 377 KB
- GlossaryThe terms used across the site and documentation.Download PDF3 pages · 358 KB
- Developer documentationRequests and responses, accepted operations, certification and common questions in one document.Download PDF16 pages · 1.1 MB
Shared during technical review
API specification · Security and compliance · Supported API formats