find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hypto:hypto-payments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Hypto Payments API
  version: 1.0.0
  description: Hypto Partner APIs are completely RESTful and all our responses are returned in JSON.
  x-logo:
    url: /docs/assets/images/logo-new.svg
    href: /
servers:
- url: //partners.hypto.in
tags:
- name: Payments
  description: This section explains how to initiate a fund transfer to any bank account and check the status of the transaction.
paths:
  /api/transfers/initiate:
    post:
      tags:
      - Payments
      summary: Initiate Fund Transfers
      description: Transfer amount to any bank account
      operationId: fund_transfer
      parameters:
      - name: Authorization
        description: API Token value from 'Settings'
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - amount
              - payment_type
              - note
              properties:
                amount:
                  description: Decimal amount > 0 and less than balance
                  type: float
                payment_type:
                  description: 'IMPS (amount <= 5L)


                    NEFT (banking hours amount <= 1Cr / non-banking hours amount <= 30L)


                    RTGS (amount >= 2L / banking hours amount <= 5Cr)


                    UPI (amount <= 1L)


                    To change transfer limits contact Hypto support'
                  type: string
                ifsc:
                  description: Bank IFSC Code `required for IMPS/NEFT/RTGS`
                  type: string
                  required: true
                number:
                  description: Bank Account Number `required for IMPS/NEFT/RTGS`
                  type: string
                upi_id:
                  description: 'UPI ID of the beneficiary.


                    `either upi_id or ifsc & number is required for UPI`'
                  type: string
                note:
                  type: string
                  description: "Only alphanumeric and space are allowed. \n\nMin characters: 2"
                udf1:
                  type: string
                udf2:
                  type: string
                udf3:
                  type: string
                beneficiary_name:
                  type: string
                  maxLength: 35
                  description: "Only alphanumeric and space are allowed. \n\n Max characters: 35"
                reference_number:
                  type: string
                  description: Only alphanumeric characters, hyphen, underscore or dot are allowed
                connected_banking:
                  type: boolean
                  default: false
                bank:
                  type: string
                  description: required only if `connected_banking is true`
                  default: KOTAK
            example:
              amount: 50
              payment_type: IMPS
              ifsc: HDFC0001234
              number: '1234567890'
              note: Fund Transfer Test
              udf1: UDF Test 1
              udf2: UDF Test 2
              udf3: UDF Test 3
              reference_number: DEMOREFNUM0123
              connected_banking: false
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 7
                      txn_time:
                        type: string
                        example: '2020-02-29 18:18:14'
                      created_at:
                        type: string
                        example: '2020-02-29 18:18:14'
                      txn_type:
                        type: string
                        example: Bank Transfer
                      status:
                        type: string
                        example: PENDING
                        enum:
                        - PENDING
                        - COMPLETED
                        - FAILED
                      amount:
                        type: float
                        example: 53.54
                      charges_gst:
                        type: float
                        example: 3.54
                      settled_amount:
                        type: float
                        example: 50
                      bank_ref_num:
                        type: string
                        example: '-'
                      closing_balance:
                        type: string
                        example: '25756.76'
                      payment_type:
                        type: string
                        example: IMPS
                      reference_number:
                        type: string
                        example: DEMOREFNUM0123
                      connected_banking:
                        type: boolean
                        example: false
                      transfer_reason:
                        type: string
                        example: ''
                      transfer_beneficiary_name:
                        type: string
                        example: ''
                      transfer_account_number:
                        type: string
                        example: '1234567890'
                      transfer_account_ifsc:
                        type: string
                        example: HDFC0001234
                      transfer_upi_id:
                        type: string
                        example: ''
                      transfer_note:
                        type: string
                        example: Fund Transfer Test
                      transfer_udf1:
                        type: string
                        example: UDF Test 1
                      transfer_udf2:
                        type: string
                        example: UDF Test 2
                      transfer_udf3:
                        type: string
                        example: UDF Test 3
                      transfer_account_holder:
                        type: string
                        example: ''
                      transfer_initiated_account_ifsc:
                        type: string
                        example: HDFC0001234
                      txn_id:
                        type: string
                        example: DEMOREFNUM0123
        '400':
          description: Unable to initiate withdrawal
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    description: Insufficient Balance or Network error or any invalid characters/pattern
                    example: Unable to initiate withdrawal
                  reason:
                    type: string
                    example: Balance Insufficient
  /api/transfers/status/{reference_number}:
    get:
      tags:
      - Payments
      summary: Fetch Status
      description: Fetch the status of Transaction
      operationId: fetch_status
      parameters:
      - name: Authorization
        description: API Token value from 'Settings'
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
      - name: reference_number
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 7
                      txn_time:
                        type: string
                        example: '2020-02-29 18:18:14'
                      created_at:
                        type: string
                        example: '2020-02-29 18:18:14'
                      txn_type:
                        type: string
                        example: Bank Transfer
                      status:
                        type: string
                        example: COMPLETED
                        enum:
                        - COMPLETED
                        - FAILED
                        - PENDING
                      amount:
                        type: float
                        example: 53.54
                      charges_gst:
                        type: float
                        example: 3.54
                      settled_amount:
                        type: float
                        example: 50
                      bank_ref_num:
                        type: string
                        example: '1234567890'
                      closing_balance:
                        type: string
                        example: '25756.76'
                      payment_type:
                        type: string
                        example: IMPS
                      reference_number:
                        type: string
                        example: DEMOREFNUM0123
                      connected_banking:
                        type: boolean
                        example: false
                      transfer_reason:
                        type: string
                        example: ''
                      transfer_beneficiary_name:
                        type: string
                        example: ''
                      transfer_account_number:
                        type: string
                        example: '1234567890'
                      transfer_account_ifsc:
                        type: string
                        example: HDFC0001234
                      transfer_upi_id:
                        type: string
                        example: ''
                      transfer_note:
                        type: string
                        example: Fund Transfer Test
                      transfer_udf1:
                        type: string
                        example: UDF Test 1
                      transfer_udf2:
                        type: string
                        example: UDF Test 2
                      transfer_udf3:
                        type: string
                        example: UDF Test 3
                      transfer_account_holder:
                        type: string
                        example: DEMO RECIPIENT
                      transfer_initiated_account_ifsc:
                        type: string
                        example: HDFC0001234
        '404':
          description: Unable to fetch Transaction status
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Unable to fetch status
                  reason:
                    type: string
                    description: Invalid Transaction Id or Network error
                    example: Transaction not found
        '429':
          description: You have exceeded the number of attempts. Please try again after sometime
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                example:
                  success: false
                  message: You have exceeded the number of attempts. Please try again after sometime
x-tagGroups:
- name: ''
  tags:
  - api_url
  - Payments
  - Banking
- name: UPI
  tags:
  - UPI
  - UPI_Collections
- name: ''
  tags:
  - Status
  - Webhooks
  - Generate_QR