conomy_hq
  1. Quickstart
conomy_hq
  • Quickstart
    • Introduction
    • Obtain an Access Token
    • Create an Organization
    • Create users
    • Create accounts
    • Create your first top-up
    • Create your first withdrawal
    • Create your first purchase
    • Create your first p2p payment
    • Create your first collect payment
    • Supported Identity Document Types
  • Payments
    • Transaction types
    • Transaction status
    • Origins and Destinations
    • Creating a payment
    • Add & remove Fees
  • API reference
    • Auth
      • Auth
    • Identities
      • Create Identity
      • Get Identity
      • Update Identity
      • Delete Identity
      • Get Identities List
      • Add Child to Identity Children
      • Remove Child from Children
      • Add Rule to Identity
      • Remove Rule to Identity
    • Accounts
      • Create Account
      • Get Account
      • Update Account
      • Delete Account
      • Get multiple accounts
    • Payment-methods
      • Get payment-origins
      • Get payment-destinations
    • Payment-attempts
      • Create Attempt
      • Get payment-attempts list
      • Get payment-attempt
    • Payments
      • Create Payment
      • Authorize Payment
      • Capture Payment
      • Get Payment List
      • Get Payment List paginated
      • Get Payment
      • Receive Payment Provider Notification
      • Client Transaction's Notification Webhook
  1. Quickstart

Introduction

This guide will help you integrate with our API step by step, allowing you to create organizations, users, accounts, and process transactions.

Prerequisites#

Before you begin, ensure you have:
A valid API Key.
Your Client ID and Client Secret.
A development environment with cURL or an API testing tool like Postman.
A registered sandbox account.

Quick Start Overview#

This guide will walk you through the following steps:

1. Obtain an Access Token#

Authenticate your API requests by obtaining an access token. This will be used in all subsequent API calls.
Go to Step 1 →

2. Create an Organization#

Set up an organization that will be used to manage users and transactions.
Go to Step 2 →

3. Create Users#

Register two users and link them to the organization.
Go to Step 3 →

4. Create Accounts#

Open a checking account for the organization and users.
Go to Step 4 →

5. Create Your First Top-Up payment#

Fund an account by making a top-up payment.
Go to Step 5 →

6. Create Your First Withdrawal#

Make a withdrawal from an account.
Go to Step 6 →

Next Steps#

To get started, proceed to Step 1: Obtain an Access Token.
Modified at 2025-01-31 21:01:09
Next
Obtain an Access Token
Built with