</noscript> <div id="wrapper" class="clearfix "> <div id="notify"> <div class="container"> <div class="col-md-10 col-sm-10"> <h3>Updated Cookies Notice – you'll see this message only once.</h3> <p>We use cookies and similar technology on this website, which helps us to know a little bit about you and how you use our website. This improves the browsing experience for you and enables us to tailor better products and services to you and others. Cookies are stored locally on your computer or mobile device. To accept cookies continue browsing as normal or go to the <a href="https://www.paysafe.com/legal-and-compliance/cookie-policy/" target="_blank" class="external-link-new-window">Cookies Notice<svg viewBox="0 0 1000 1000" class="icon icon-developer-external-link"><use xlink:href="#icon-developer-external-link"/></svg></a> for more information and to set your preferences. </p> </div> <div class="col-md-2 col-sm-20"> <span class="button notify-close">Accept and Close</span> </div> </div> </div> <header id="header" class="no-sticky"> <div id="header-wrap"> <div class="col-md-12 clearfix"> <div id="logo"> <a title="paysafe developer" href="/en/"><img src="/typo3conf/ext/theme/Resources/Public/Template/images/logo.svg" alt="paysafe developer"></a> </div> <nav class="primary-menu mobile"> <ul class="top-nav-sub style-2"> <li class="mega-menu"><a href="https://login.test.netbanx.com/office/public/preLogin.htm?utm_source=developer.paysafe.com&utm_medium=referral&utm_campaign=login-button" target="_blank"><div>LOGIN</div></a></li> <li class="mega-menu menu-btn"><a href="#" data-toggle="modal" data-target="#signup"><div>SIGN UP</div></a></li> </ul> </nav> <nav class="primary-menu desktop"> <ul> <li class="mega-menu sub-menu"> <a href="#" class="menu-trigger start-mega"><div class="desktop">START HERE</div></a> </li> <li class="mega-menu"><a href="/en/landing/api-reference/"><div>API REFERENCE</div></a></li><li class="mega-menu"><a href="/en/landing/sdks/"><div>SDKs</div></a></li><li class="mega-menu"><a href="/en/landing/community-support/"><div>COMMUNITY & SUPPORT</div></a></li> </ul> <ul class="top-nav-sub"> <li class="mega-menu"><a href="#" class="search"><div><svg viewBox="0 0 1000 1000" class="icon icon-developer-search"><use xlink:href="#icon-developer-search"/></svg></div></a></li> <li class="mega-menu"><a href="https://login.test.netbanx.com/office/public/preLogin.htm?utm_source=developer.paysafe.com&utm_medium=referral&utm_campaign=login-button" target="_blank"><div>LOGIN</div></a></li> <li class="mega-menu menu-btn"><a href="#" data-toggle="modal" data-target="#signup"><div>SIGN UP</div></a></li> </ul> </nav> </div> <div class="clearfix mobile"> <nav class="primary-menu"> <ul> <li class="mega-menu sub-menu"> <a href="#" class="menu-trigger"><div class="mobile"><svg viewBox="0 0 12 14" class="icon icon-developer-bars"><use xlink:href="#icon-developer-bars"/></svg></div></a> </li> <li class="mega-menu"><a href="/en/landing/api-reference/"><div>API REFERENCE</div></a></li><li class="mega-menu"><a href="/en/landing/sdks/"><div>SDKs</div></a></li><li class="mega-menu"><a href="/en/landing/community-support/"><div>COMMUNITY & SUPPORT</div></a></li> </ul> <ul class="top-nav-sub"> <li class="mega-menu"><a href="#" class="search"><div><svg viewBox="0 0 1000 1000" class="icon icon-developer-search"><use xlink:href="#icon-developer-search"/></svg></div></a></li> </ul> </nav> </div> <div class="col-md-12 clearfix"> <div id="megamenu"> <div class="mega-menu-content style-2 clearfix"> <div class="col-md-3 col-sm-3"> <ul class="mega-col1"> <li class="mega-menu-title sub-menu"> <a href="/en/rest-apis/welcome/" class="mega-title"><div>Payments</div></a> <ul> <li class="mega-sub"> <a href="/en/rest-apis/cards/getting-started/introduction-to-card-payments/" class="mega-title">Cards</a> <a href="/en/cards/api/" class="api-btn api-icon">API</a> </li> <li class="mega-sub"> <a href="/en/rest-apis/alternate-payments/getting-started/overview/" class="mega-title">Alternates</a> <a href="/en/alternates/api/" class="api-btn api-icon">API</a> </li> <li class="mega-sub"> <a href="/en/rest-apis/direct-debit/getting-started/introduction-to-direct-debit-payments/" class="mega-title">Direct Debit</a> <a href="/en/direct-debit/api/" class="api-btn api-icon">API</a> </li> <li class="mega-sub"> <a href="/en/rest-apis/vault/getting-started/introduction-to-the-customer-vault/" class="mega-title">Vault</a> <a href="/en/vault/api/" class="api-btn api-icon">API</a> </li> <li class="mega-sub"> <a href="/en/rest-apis/3ds/getting-started/introduction-to-3d-secure/" class="mega-title">3D Secure</a> <a href="/en/3d-secure/api/" class="api-btn api-icon">API</a> </li> </ul> </li> </ul> </div> <div class="col-md-3 col-sm-3"> <ul class="mega-col2"> <li class="mega-menu-title sub-menu"> <a href="/en/sdks/server-side/introduction/" class="mega-title"><div>SERVER-SIDE SDKs</div></a> <ul> <li class="mega-sub"> <a href="/en/sdks/server-side/ruby/getting-started/" class="mega-title">Ruby<svg viewBox="0 0 1000 1000" class="icon icon-developer-ruby-programming-language"><use xlink:href="#icon-developer-ruby-programming-language"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/server-side/python/getting-started/" class="mega-title">Python<svg viewBox="0 0 1000 1000" class="icon icon-developer-python"><use xlink:href="#icon-developer-python"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/server-side/php/getting-started/" class="mega-title">PHP<svg viewBox="0 0 1438 1000" class="icon icon-developer-php"><use xlink:href="#icon-developer-php"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/server-side/c/getting-started/" class="mega-title">C#<svg viewBox="0 0 1000 1000" class="icon icon-developer-csharp"><use xlink:href="#icon-developer-csharp"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/server-side/node/getting-started/" class="mega-title">Node<svg viewBox="0 0 1438 1000" class="icon icon-developer-nodejs"><use xlink:href="#icon-developer-nodejs"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/server-side/java/getting-started/" class="mega-title">Java<svg viewBox="0 0 1000 1000" class="icon icon-developer-java"><use xlink:href="#icon-developer-java"/></svg></a> </li> </ul> </li> </ul> <ul class="mega-col2"> <li class="mega-menu-title sub-menu"> <a href="/en/sdks/mobile/mobile-sdks/" class="mega-title"><div>CLIENT-SIDE SDKs</div></a> <ul> <li class="mega-sub"> <a href="/en/sdks/mobile/android/overview/" class="mega-title">Android<svg viewBox="0 0 1000 1000" class="icon icon-developer-android-os"><use xlink:href="#icon-developer-android-os"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/mobile/ios/overview/" class="mega-title">iOS<svg viewBox="0 0 1000 1000" class="icon icon-developer-mac-client"><use xlink:href="#icon-developer-mac-client"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/paysafejs/overview/" class="mega-title">Paysafe.js<svg viewBox="0 0 1769 1000" class="icon icon-developer-paysafejs"><use xlink:href="#icon-developer-paysafejs"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/paysafe-checkout/overview/" class="mega-title">Paysafe Checkout<svg viewBox="0 0 1769 1000" class="icon icon-developer-paysafe-checkout"><use xlink:href="#icon-developer-paysafe-checkout"/></svg></a> </li> <li class="mega-sub"> <a href="/en/sdks/paysafe-request/paysafe-request-overview/" class="mega-title">Paysafe Request<svg viewBox="0 0 1348 733" class="icon icon-developer-paysafe-request"><use xlink:href="#icon-developer-paysafe-request"/></svg></a> </li> </ul> </li> </ul> </div> <div class="col-md-3 col-sm-3"> <ul class="mega-col3"> <li class="mega-menu-title sub-menu"> <a href="/en/rest-apis/platforms/overview/" class="mega-title"><div>PLATFORMS</div></a> <ul> <li class="mega-sub"> <a href="/en/rest-apis/platforms/account-management/getting-started/introduction-to-account-management/" class="mega-title">Accounts</a> <a href="/en/platforms/accounts/api/" class="api-btn api-icon">API</a> </li> <li class="mega-sub"> <a href="/en/rest-apis/platforms/split-payouts/split-payouts-overview/" class="mega-title">Split Payouts</a> </li> <li class="mega-sub"> <a href="/en/rest-apis/platforms/balance-transfers/" class="mega-title">Balance Transfers</a> </li> </ul> </li> </ul> <ul class="mega-col3"> <li class="mega-menu-title sub-menu"> <a href="/en/shopping-carts/" class="mega-title"><div>SHOPPING CARTS</div></a> <ul> <li class="mega-sub"> <a href="/en/shopping-carts/magento/" class="mega-title">Magento</a> </li> <li class="mega-sub"> <a href="/en/shopping-carts/nopcommerce/" class="mega-title">nopCommerce</a> </li> <li class="mega-sub"> <a href="/en/shopping-carts/woocommerce/" class="mega-title">WooCommerce</a> </li> </ul> </li> </ul> <ul class="mega-col3"> <li class="mega-menu-title sub-menu"> <div class="mega-title"><div>ADDITIONAL DOCUMENTATION</div></div> <ul> <li class="mega-sub"> <a href="/en/additional-documentation/account-updater/overview/" class="mega-title">Account Updater</a> </li> </ul> </li> </ul> </div> <div class="col-md-3 col-sm-3"> <ul class="mega-col4"> <li class="mega-menu-title sub-menu"> <a href="/en/landing/community-support/" class="mega-title"><div>COMMUNITY AND SUPPORT</div></a> <ul> <li class="mega-sub"> <a href="https://www.paysafe.com/general-contact/" class="external-link" target="_blank">Contact Sales<svg viewBox="0 0 1000 1000" class="icon icon-developer-external-link"><use xlink:href="#icon-developer-external-link"/></svg></a> </li> <li class="mega-sub"> <a href="http://stackoverflow.com/questions/tagged/netbanx-api?sort=newest&pageSize=50" class="external-link" target="_blank">Top Questions on Stack Overflow<svg viewBox="0 0 1000 1000" class="icon icon-developer-external-link"><use xlink:href="#icon-developer-external-link"/></svg></a> </li> <li class="mega-sub"> <a href="http://community.paysafe.com/index.html" class="external-link" target="_blank">Ask Our Community<svg viewBox="0 0 1000 1000" class="icon icon-developer-external-link"><use xlink:href="#icon-developer-external-link"/></svg></a> </li> <li class="mega-sub"> <a href="http://community.paysafe.com/questions/ask.html?space=13" class="external-link" target="_blank">Report a Bug<svg viewBox="0 0 1000 1000" class="icon icon-developer-external-link"><use xlink:href="#icon-developer-external-link"/></svg></a> </li> <li class="mega-sub"> <a href="http://community.paysafe.com/spaces/11/index.html" class="external-link" target="_blank">FAQs<svg viewBox="0 0 1000 1000" class="icon icon-developer-external-link"><use xlink:href="#icon-developer-external-link"/></svg></a> </li> </ul> </li> </ul> </div> <div class="clear"></div> <div class="row menu-signup"> <div class="col-md-8 col-md-offset-2"> <div class="mb20 "> <div id="c1303" class="grid3 clearfix "> <div class="clearfix"> <div class="clear"></div> <div class="col-md-4 col-sm-4"> <div class="img-center img-icon "> </div> <div class="grid-content"> <h2>Create a Test<br />Account </h2> </div> </div> <div class="col-md-4 col-sm-4"> <div class="img-center img-icon "> </div> <div class="grid-content"> <ul><li>Sign up for a test account in seconds</li><li>Obtain a feel for Paysafe integration</li><li>Experiment securely and freely </li></ul> </div> </div> <div class="col-md-4 col-sm-4"> <div id="c1306" class=""> <p class="align-center"><a class="button" data-toggle="modal" data-target="#signup" href="#">SIGN UP</a></p> <p class="align-center">Already have an account? <a href="https://login.test.netbanx.com/office/public/preLogin.htm?utm_source=developer.paysafe.com&utm_medium=referral&utm_campaign=login-button" target="_blank">Login Now</a></p> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div id="top-search" class="clearfix"> <div class="container clearfix"> <div class="col-md-12 center"> <form method="get" id="form_kesearch_pi1" name="form_kesearch_pi1" action="/en/search/"> <fieldset class="kesearch_searchbox"> <input type="hidden" name="tx_kesearch_pi1[redirect]" value="0" /> <div class="form-group has-success has-feedback"> <input type="text" class="form-control" id="ke_search_sword" name="tx_kesearch_pi1[sword]" value="" placeholder="SEARCH" /> <span class="clear-search form-control-feedback clear-search-big">X</span> </div> <input id="kesearchpagenumber" type="hidden" name="tx_kesearch_pi1[page]" value="" /> <input id="resetFilters" type="hidden" name="tx_kesearch_pi1[resetFilters]" value="0" /> <input id="sortByField" type="hidden" name="tx_kesearch_pi1[sortByField]" value="" /> <input id="sortByDir" type="hidden" name="tx_kesearch_pi1[sortByDir]" value="" /> <span class="submitbutt"> <button type="submit" class="button sbutton"><svg viewBox="0 0 1000 1000" class="icon icon-developer-search"><use xlink:href="#icon-developer-search"/></svg></button> </span> </fieldset> </form> </div> </div> </div> <div class="clear"></div> </div> <div class="modal fade" id="signup" tabindex="-1" role="dialog" aria-labelledby="signup" aria-hidden="true"> <div class="modal-dialog"> <div class="modal-body"> <div class="modal-content"> <div class="modal-header nobottompadding center"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true"><svg viewBox="0 0 11 14" class="icon icon-developer-close"><use xlink:href="#icon-developer-close"/></svg></button> <div class="clear"></div> </div> <div class="modal-body notoppadding"> <iframe width="620" height="830" src="https://paysafe-meritus.secure.force.com/testaccount/">
REST APIs
Welcome
Cards
Getting Started
Introduction to Card Payments
Before You Start
Using the API
Scenarios
API Endpoints
Making API Calls
Demonstration
Typical API Calls
Verify That the Service Is Accessible
Validate a Credit Card
Process a Purchase
Process an Authorization Followed by a Settlement
Overview
Process an Authorization
Look Up an Authorization Transaction
Process a Settlement
Cancel a Pending Settlement
API Reference
Test and Go Live
Testing Instructions
Test Cards
Simulating Card Payments
Simulating CVV Responses
Simulating AVS Responses
Card Errors
Troubleshooting API Requests
Going Live
Additional Information
3D Secure
Recurring Payments
3DS
Getting Started
Introduction to 3D Secure
Before You Start
Using the API
Scenarios
API Endpoints
Making API Calls
Typical API Calls
Verify That the Service Is Accessible
Perform an Enrollment Lookup
Submit a Request to the 3D Secure ACS Server and Retrieve a PaRes
Validate a 3D Secure Authentication Result
Process a Card Purchase with 3D Secure
API Reference
Test and Go Live
Testing Instructions
Test Cards
3D Secure Results and Liability Shift
3D Secure Errors
Troubleshooting API requests
Going Live
Vault
Getting Started
Introduction to the Customer Vault
Before You Start
Using the API
Scenarios
API Endpoints
Making API Calls
Typical API Calls
Verify That the Service Is Accessible
Create a Profile for a Customer
Add an Address to a Profile
Add a Card to a Profile
Add a Bank Account to a Profile
Create an Apple Pay Single-Use Token
Create a Google Pay Single-Use Token
Create a Mobile Single-Use Token
Create a Direct Debit Single-Use Token
Process a Transaction Using a Payment Token
API Reference
Test and Go Live
Testing instructions
Vault Errors
Troubleshooting API requests
Going Live
Direct Debit
Getting Started
Introduction to Direct Debit Payments
Before You Start
Using the API
Scenarios
API Endpoints
Making API Calls
Typical API Calls
Verify That the Service Is Accessible
Process a Purchase
Purchase Message Sequence
Look Up a Purchase Transaction
Create a Payment Token
API Reference
Test and Go Live
Testing Instructions
Direct Debit Errors
Troubleshooting API Requests
Going Live
Alternate Payments
Getting Started
Overview
Before You Start
Webhooks
Webhook Samples
Using the API
API Endpoints
Making Your First API Call
Typical API Calls
Verify That the Service Is Accessible
Make a Payment
Void an Authorization
Process a Settlement
Process a Refund
API Reference
Payment Type Considerations
Paysafe Pay Later
Paysafecash
Test and Go Live
Testing Instructions
Alternate Payments Errors
Troubleshooting
Going Live
Platforms
Overview
Account Management
Getting Started
Introduction to Account Management
Account Hierarchy Model
Overview of the Onboarding Flow
Onboarding Fields
Before You Start
Using the API
API Endpoints
API Reference
Typical API Calls
Verify That the Service Is Accessible
Create a New Merchant
Create a New Merchant Account
Create a New User
Add an Address
Create a Business Owner
Add a Business Owner Address
Add a Business Owner Identity Document
Add a Merchant Bank Account
Accept Our Terms and Conditions
Business Owner Identity Verification
Activate the New Merchant Account
Validate the Bank Account
Validate the Microdeposit
Enable Webhooks to Receive Application Statuses
Using the Paysafe Identity Verification API
Identification Request Elements
Identification Request Test Values for Canadian Merchants
Identity Verification API Errors
Test and Go Live
Account Management Errors
Troubleshooting API Requests
Going Live
Split Payouts
Split Payouts Overview
Processing a Split Payouts Card Purchase
Processing a Split Payouts Card Settlement
Processing a Split Payouts Card Refund
Processing a Split Payouts Direct Debit Purchase
Processing a Split Payouts Direct Debit Standalone Credit
Balance Transfers
Reference Information
Important Integration Concepts
PCI DSS
Using your API Key
REST API Architecture
Using Curl
Authentication
API Versions and Compatibility
Global Invalid Characters
Managing Payments
Paysafe Merchant Back Office
Handling Chargebacks
ISO Country and Currency Codes
State Codes
Province Codes
Country Codes
Currency Codes
SDKs
Server Side
Introduction
Ruby
Getting Started
Cards
Customer Vault
Direct Debit
3DS
Exceptions
Python
Getting Started
Cards
Customer Vault
Direct Debit
3DS
Exceptions
Php
Getting Started
Cards
Customer Vault
Direct Debit
3DS
Exceptions
Node
Getting Started
Cards
Customer Vault
Direct Debit
3DS
Exceptions
C#
Getting Started
Cards
Customer Vault
Direct Debit
3DS
Exceptions
Java
Getting Started
Cards
Customer Vault
Direct Debit
3DS
Exceptions
Paysafe.js
Overview
Setup
Event Handling
Tokenize
Card Payment with Token
Multiple Currencies
Additional Functions
Going Live
Paysafe Checkout
Overview
Setup Function
More Examples
Card Payment with Token
Direct Debit Payment with Token
Interac Online Payment with Token
Multiple Currencies
Additional Checkout Functions
Testing
Going Live
Paysafe Request
Paysafe Request Overview
Using the Paysafe Request SDK
init Function
onTokenization Function
showButtons Function
canMakePayment Function
updateOptions Function
Paysafe Request Errors
Mobile
Mobile SDKs
iOS
Overview
How It Works
Integration Options
Mobile API keys
Integrating with the iOS SDK
Overview
Apple Pay Setup
Initial Configuration for Apple Pay
Xcode Setup
Checking Apple Pay Availability
Running a Sample Application
Installing and Initializing
Initiating a Payment
Initiating a Payment for Apple Pay
Initiating a Payment for Mobile iOS Payments
Receiving the SDK Response
Debugging
Going Live
Integrating with the Paysafe REST APIs
Android
Overview
Introduction to Google Pay
How It Works
Integration Options
Mobile API Keys
Integrating with the Android SDK
Overview
Google Pay Setup
Integrating with Google Pay
Installing Android Studio
Using Android Studio IDE
Initializing the Paysafe Library
Payment for Google Pay
Initiating a Payment for Mobile Android Payments
Going Live
Integrating with the Paysafe REST APIs
Additional Documentation
Account Updater
Overview
Customer Profile Option
Customer Vault Option
File-based Option
Creating Account Updater Files
Uploading Your Files
Downloading Files
Codes and Descriptions
Resources and Support
More Documentation
Payment Logos
PCI DSS Validation
Contact Us
Terms Of Use
Onboarding
Sending Data Securely
Shopping Carts
Magento
Installing and Updating the Magento 2 Integration
Configuring the Magento 2 Integration
Using the Magento 2 Integration
nopCommerce
WooCommerce
Classic APIs
Hosted Payments
Getting Started
Overview
Before You Start
Using the API
Scenarios
API Endpoints
Making API Calls
Typical API Calls
Verify the Service is Accessible
Process an Order Using a Hosted Page
Process an Order Using a Silent Post
Process an Order with Settlement
Cancel a Pending Order
Look Up an Order
API Reference
Test and Go Live
Implementing ThreatMetrix for a Silent Post Order
Testing Instructions
Hosted Errors
Troubleshooting API Requests
Going Live
Web Services
Overview
Doc and API
Test Cards
Code Samples
Glossary
State Codes
State
Code
Alabama
AL
Alaska
AK
American Samoa
AS
Arizona
AZ
Arkansas
AR
Armed Forces Americas
AA
Armed Forces Europe
AE
Armed Forces Pacific
AP
California
CA
Colorado
CO
Connecticut
CT
Delaware
DE
District of Columbia
DC
Florida
FL
Georgia
GA
Guam
GU
Hawaii
HI
Idaho
ID
Illinois
IL
Indiana
IN
International
IT
Iowa
IA
Kansas
KS
Kentucky
KY
Louisiana
LA
Maine
ME
Maryland
MD
Massachusetts
MA
Michigan
MI
Minnesota
MN
Mississippi
MS
Missouri
MO
Montana
MT
Nebraska
NE
Nevada
NV
New Hampshire
NH
New Jersey
NJ
New Mexico
NM
New York
NY
North Carolina
NC
North Dakota
ND
Northern Mariana Is.
MP
Ohio
OH
Oklahoma
OK
Oregon
OR
Palau
PW
Pennsylvania
PA
Puerto Rico
PR
Rhode Island
RI
South Carolina
SC
South Dakota
SD
Tennessee
TN
Texas
TX
U.S. Virgin Islands
VI
United States Federal
US
Utah
UT
Vermont
VT
Virginia
VA
Washington
WA
West Virginia
WV
Wisconsin
WI
Wyoming
WY
PREV
NEXT
Did you find this page useful?
Thank you for your feedback!
Skip
Submit
