Merchant Tools

Getcryptopayments API

Basics

Introduction

Informational Commands

  • Get Exchange Rates / Supported Coins
  • Merchant created Terminals List
  • Terminal Creation

    • Receiving Payments

  • Create Transaction

    • Create Transaction

    API POST url

    https://gcps.io/en/mtools/api/merchant_terminal_auth

    API POST Fields
    Field Name Description Required?
    api_key Your API key Yes
    secret_key Your secret key (string) Yes
    coin_code The selected Coin code (string) Yes
    amount The Transaction amount (float/integer) Yes
    transaction_id Unique ID to identify transaction (string) Yes
    invoice_id Invoice ID (string) Yes
    currency_code Code of the currency (default=USD) Yes
    API Response

    A successful call to this command will give you a result similar to this (JSON):

    {
         "status": 1,
         "payment_address": "testpayment",
         "payment_status": "in progress",
         "payment_amount_in_cryptocurrency": 0.02638728683675155,
         "invoice_id": "1254",
         "transaction_id": "12542",
         "payment_time_limit": "2020-09-17T21:26:25.785199Z"
    }

    The result wil have the following fields:

    1. status = The status of the API call.
      1 = Success
      0 = Failed
    2. payment_address = The address the buyer needs to send the coins to.
    3. payment_status = The status of the payment.
    4. payment_amount_in_cryptocurrency = The amount for the buyer to send in the destination currency
    5. invoice_id = Invoice ID of the Item (value passed by merchant)
    6. transaction_id = Transaction ID of the Item (value passed by merchant)
    7. payment_time_limit = Time limit for the buyer to send the currency to the address

    The user has 15 hours for completing the payment.
    This time should be considered as the payment in progress by the merchant.

    if the user completed the payment before this time limit expires, then the following response will be posted from GCPS server to the Merchant response API URL with Status code 1 indicating the payment received from the user.

    {
         "status": 1,
         "payment_address": "testpayment",
         "payment_amount_in_cryptocurrency": 0.02638728683675155,
         "invoice_id": "ss1254",
         "transaction_id": "gv12542",
         "message": "Transaction Success"
    }

    if the user not completed the payment before this time limt expires, then the following response will be posted from GCPS server to the Merchant response API URL with Status code 0 indicating the payment not received from the user.

    {
         "status": 0,
         "payment_address": "testpayment",
         "payment_amount_in_cryptocurrency": 0.02638728683675155,
         "invoice_id": "ss1254",
         "transaction_id": "gv12542",
         "message": "Transaction Time Expired"
    }