Jump to Content

Guides API Reference Support

Guides API Reference

Guides API Reference Support Log In

API Reference

Guides API Reference

Overview

Introduction
Trying our API using Postman
API SDKs
Request Headers
Authentication and Authorization
- Legacy Authorization
Response Body
HTTP Status Codes
Error Responses

Walkthroughs

Collect Payment for New Customer
Collect Payment for Existing Customer

Customers

Customer Object
New Customerpost
Get Customerget
List Customersget
List Accounts for Customerget
Set Default ACH/CCput
ACH Accountsget
Credit Card Accountsget
Default ACHget
Default Credit Cardget
List Payments for Customerget
Update Customerput
Delete Customerdelete

Accounts

Understanding Accounts
New Credit Cardpost
New ACHpost
Get Credit Cardget
Get ACH Accountget
Update Credit Cardput
Update ACHput
Delete Credit Carddelete
Delete ACHdelete

Payments

Get Paymentget
New Paymentpost
Refund Paymentput
List Paymentsget
Payment Response
Void Paymentput
Payment Statuses
Payment Failure / Decline Codes
Generating Test Errors

Recurring Payments

New Recurring Paymentpost
Get Recurring Paymentget
List Recurring Paymentsget
List Customer Recurring Paymentsget
List Paymentsget
Update Recurring Paymentput
Suspend Scheduleput
Pause Scheduleput
Resume Scheduleput
Delete Recurring Paymentdelete

Merchant

Payment Optionsget

Overview

Introduction
Trying our API using Postman
API SDKs
Request Headers
Authentication and Authorization
- Legacy Authorization
Response Body
HTTP Status Codes
Error Responses

Walkthroughs

Collect Payment for New Customer
Collect Payment for Existing Customer

Customers

Customer Object
New Customerpost
Get Customerget
List Customersget
List Accounts for Customerget
Set Default ACH/CCput
ACH Accountsget
Credit Card Accountsget
Default ACHget
Default Credit Cardget
List Payments for Customerget
Update Customerput
Delete Customerdelete

Accounts

Understanding Accounts
New Credit Cardpost
New ACHpost
Get Credit Cardget
Get ACH Accountget
Update Credit Cardput
Update ACHput
Delete Credit Carddelete
Delete ACHdelete

Payments

Get Paymentget
New Paymentpost
Refund Paymentput
List Paymentsget
Payment Response
Void Paymentput
Payment Statuses
Payment Failure / Decline Codes
Generating Test Errors

Recurring Payments

New Recurring Paymentpost
Get Recurring Paymentget
List Recurring Paymentsget
List Customer Recurring Paymentsget
List Paymentsget
Update Recurring Paymentput
Suspend Scheduleput
Pause Scheduleput
Resume Scheduleput
Delete Recurring Paymentdelete

Merchant

Payment Optionsget

Request Headers

Required HTTP headers for all requests

Content-Type
Must be set to value application/json

Authorization
See Authentication and Authorization