Payments APIs

Payments processing is organized by tender type, with separate sets of API calls to handle payments by credit cards, gift cards, and PayPal.

See the following pages for processes that apply to multiple tender types:

• Tender Types
• Tender Type Lookup
• Transaction History
• Confirm Funds
• Accounts for API Testing
• Payment Settlement (asynchronous API process)
• Payment Authorization Cancel (asynchronous API process)
• Bank Transfer Status (asynchronous API process)

Afterpay Processing

For an overview, see Afterpay Processing. See the following pages for API reference:

• Afterpay Get Payment Configuration
• Afterpay Initialize Payment Authorization
• Afterpay Get Payment Authorization

Alipay Processing

For an overview, see Alipay Processing. See the following pages for API reference:

• Alipay Get Payment
• Alipay Payment Status

Apple Pay Processing

For an overview, see Apple Pay Processing and Apple Pay Web Integration. See the following pages for API reference:

• iOS Sample Code
• Credit Card Authorization

Bank Transfer Processing

For an overview, see Bank Transfer Processing. See the following pages for API reference:

• Bank Transfer Request
• Bank Transfer Status Request

Credit Card Processing

For an overview, see Credit Card Processing. See the following pages for API reference:

• Credit Card Auth
• Card Not Present Authorization Request
• Digital Wallet Authorization Request
• Credit Card Authorization Response Codes
• AVS Response Codes
• Credit Card CVV2 Response Codes
• Credit Card Fault Response Codes
• Private Label Credit Card Authorization
• Validate Credit Card Details
• Validate Card Response Codes

Gift Card Processing

For an overview, see Gift Card Processing. See the following pages for API reference:

• Gift Card Fund and Activate
• Gift Card Fund
• Gift Card Balance Inquiry
• Gift Card Redeem
• Gift Card Redeem Void
• Gift Card Cashout

Google Pay Processing

For an overview, see Google Pay Payments Setup Guide. See the following pages for additional details:

• Google Pay Web Integration
• Google Pay Application Integration

Interac® Online Processing

For an overview, see Interac® Online Processing. See the following pages for API reference:

• Interac® Online Transaction Initiation
• Interac® Online Transaction Authorization

Klarna JavaScript Integration

For an overview, see Klarna JavaScript Integration. See the following pages for API reference:

• Klarna Get Payment Authorization

Klarna Processing

For an overview, see Klarna Integration. See the following pages for API reference:

• Klarna Authorization

Link Money Processing

For an overview, see Link Money Processing. See the following pages for API reference and SDK Javascript Integration:

• Link Money Initiate Payment
• Link Money SDK JavaScript Integration
• Link Money Authorize Payment

PayPal Processing

For an overview, see PayPal Processing. See the following pages for API reference and additional details:

• PayPal SetExpress
• PayPal GetExpress
• PayPal DoExpress
• PayPal DoAuthorization

For the information previously found in PayPal SDK JavaScript Smart Button, see PayPal Processing.

The following legacy PayPal integrations are retained here for reference only: PayPal Processing [DEPRECATED], PayPal Smart Button (Deprecated by PayPal), PayPal CreateBillingAgreement, PayPal DoReference, PayPal UpdateAuthorization.

 

Venmo Processing

For an overview and integration steps, see Venmo.

Payment Wallet

For an overview, see Payment Wallet. See the following pages for API reference:

• Create Payment Wallet
• Delete Payment Wallet
• Get Payment Wallet
• Add Payment Tender
• Delete Payment Tender
• Get Payment Tender
• Update Payment Tender

Encryption and Security

• Client-Side Encryption
• Protect PAN
• Public Key

Payments Code Samples

The following code samples are available, using programming languages Java and PHP.

• Protect PAN Request

API Schemas

For links to XSD files for Payments APIs, see Payments API Schemas.