LogoLogo
StartAPI EndpointPayments API
Payments API
Payments API
  • Getting Started
  • Managing Terminals
  • API Reference
    • Verify Credentials
    • QuickPay SDK
    • Payments API
      • Create eCommerce Payment
      • Create Point of Sale Payment
      • Create Point of Sale Payment (ON)
      • Redirect Examples
      • Postback Examples
      • Get Payment
        • Underpaid Examples
        • Overpaid Examples
        • Full paid Examples
      • Get Point of Sale Payment
      • Payment State Change
      • Payment Price Update
      • Payment Unconfirmed Update
      • Payment Status List
    • Request Refund
Powered by GitBook
On this page
  1. API Reference
  2. Payments API

Get Payment

Get the current status of a payment that has been created

PreviousPostback ExamplesNextUnderpaid Examples

Last updated 3 years ago

Get the details of any payment you have created.

POST api/payment/detail

Request Body

Name
Type
Description

reference*

String

Your payment reference

payment_code*

String

Payment code supplied

key*

String

Merchant's

hash*

String

MD5 Hash

key+reference+amount+ or key+payment_code+amount+

{
  "status": "nok",
  "message": "Get Payment Detail Failed!",
  "error": "Payment Reference or Payment Code is required",
  "validated": false
}
{
  "status": "ok",
  "payment": {
    "merchant_id": "5e30e32b147a853ab83c3088",
    "payment_code": "n5NRlBdL23",
    "address": "0x62F741E0C90dEd5844F51122DE8FF45210999c76",
    "amount": "1000000000000000000",
    "original_amount": "2894700000000000000",
    "precision": 18,
    "txid": "0x932dbcbfe6bae0c7c7915c93fdadf6b5b891e06f9a2e62056627b9b1e8ecccef",
    "all_txids": "0x932dbcbfe6bae0c7c7915c93fdadf6b5b891e06f9a2e62056627b9b1e8ecccef",
    "asset_id": "5d3ab6b7b55b65776facd12a",
    "asset_symbol": "DEV",
    "status": "completed",
    "tracking_url": "http://209.97.161.8:3000/tx/0x932dbcbfe6bae0c7c7915c93fdadf6b5b891e06f9a2e62056627b9b1e8ecccef0x932dbcbfe6bae0c7c7915c93fdadf6b5b891e06f9a2e62056627b9b1e8ecccef",
    "from_address": "0xf1628e9be31199fCf30ef7591B6a109cFefe77F1",
    "language": "en",
    "payment_status": "3",
    "description": "ccccccc",
    "payment_reference": "1605162172227753",
    "paid_amount": "2894700000000000000",
    "paid_amount_precision": 18,
    "requested_amount": "2894700000000000000",
    "requested_amount_precision": 18,
    "exchange_rate": "61851.56",
    "transactions": [
      {
        "asset_symbol": "BTC",
        "status": "overpaid",
        "quantity": "2894700000000000000",
        "executable_quantity": "2894700000000000000",
        "tx_id": "0x932dbcbfe6bae0c7c7915c93fdadf6b5b891e06f9a2e62056627b9b1e8ecccef",
        "tx_time": 1643355882425,
        "exchange_rate": "0.9981996"
      }
    ],
    "refunds": [
      {
        "refund_code": "VOPPhUUmhE",
        "asset_symbol": "BTC",
        "refund_amount_precision": "18",
        "refund_type": "overpaid",
        "refund_amount": "2894700000000000000",
        "refund_email": "oom@teslastudio.com",
        "refund_status": "0",
        "status": "AWAITING",
        "processed_date": 1643360779
      }
    ]
  },
  "message": "Get payment detail successfully"
}

Please Note: You can only send one of reference or payment_code and your hash must include that value.

For example if you send reference your hash must be key+reference+amount+. If you send payment_code your hash must be key+payment_code+amount+

api_secret
api_secret
Terminal API ID
api_secret
api_secret