• Home
  • Services
    • Version 1
    • Version 2
    • Work in Progress
    • Open Banking
  • Appendixes
    • Action Codes
    • Transaction Codes
    • Activation Methods
    • WebService Processing Codes
    • SMS Configuration Options
    • Authentication Methods
    • Status Codes (Card Status)
    • Transaction Type
    • Transaction Status
    • ItemSrc Types
    • KYC Status

Welcome to the Crunch API Documentation!


Overview

Welcome to the Crunch API documentation! Our API provides seamless integration between Crunch and client systems, enabling efficient communication and data exchange. Whether you're building custom applications, automating workflows, or enhancing existing systems, our API offers robust functionality to meet your needs.

Purpose

The Crunch API empowers developers to access and manipulate data stored within Crunch's systems programmatically. By leveraging our API, you can retrieve financial information, manage accounts, submit transactions, and perform various other tasks without manual intervention. This automation streamlines processes, reduces errors, and enhances productivity for both developers and end-users.

Getting Started

  1. Obtain Credentials: Contact Crunch support to request API access. Once approved, you'll receive your unique credentials, including Passname, Passcode, and Client passcode.
  2. Explore Endpoints: Review the available endpoints and determine which ones are relevant to your integration needs.
  3. Test Integration: Start with our sandbox environment to test your integration and ensure everything works as expected.
  4. Go Live: Once you're confident in your integration, switch to the production environment to go live and start leveraging the full power of the Crunch API.

Request Header

Request Body


                                                
                                            

Possible Responses

Status: 200 OK
Response content for 200 OK.
Status: 401 Unauthorized
The request lacks valid Request Header or the provided credentials are invalid.
Status: 400 Bad Request
The server cannot process the request due to invalid syntax or missing parameters in the API request.

Action Codes

Action Code Description

You are about to be redirected to the customer portal. Do you want to continue?

Please note that we have two API versions available: Version 1 and Version 2.


Version 1 is considered legacy and will be deprecated in the future. We strongly advise you to use Version 2 for the latest features and support.