Crypto Pay-In API

API Endpoint

Live APIProduction environment

POSThttps://api.thepayment.company/api/v1/live/crypto/payin

Test APISandbox environment

POSThttps://api.thepayment.company/api/v1/test/crypto/payin

Request Fields

Parameter	Type	Description	Required
`first_name`	String	Payer first name	Yes
`last_name`	String	Payer last name	Yes
`email`	String	User email address	Yes
`amount`	Number	Transaction amount in the smallest currency unit	Yes
`currency`	String	Currency code in ISO 4217 format	Yes
`crypto_currency`	String	Cryptocurrency code, such as BTC, ETH, or USDT	Yes
`crypto_network`	String	Cryptocurrency network, such as ETHEREUM or BITCOIN	Yes
`ip_address`	String	User IP address	Yes
`phone_number`	String	Payer phone number	Yes
`address`	String	Billing street address	Yes
`country`	String	Country code in ISO 3166-1 alpha-2 format	Yes
`order_id`	String	Merchant-side unique order reference	Yes
`redirect_url`	String	URL where the user is redirected after payment	Yes
`webhook_url`	String	URL used for server-to-server webhook updates	No
`terminal_id`	String	Unique connector terminal ID, useful when bypassing routing and cascading logic	No

Payload

Send the request payload as JSON. The sample structure is shown below:

{
"first_name": "James",
"last_name": "Crypto",
"email": "james.crypto@gmail.com",
"amount": 100,
"currency": "USD",
"crypto_currency": "BTC",
"crypto_network": "BITCOIN",
"ip_address": "127.0.0.1",
"phone_number": "7654233212",
"address": "64 Hertingfordbury Rd",
"order_id": "CRYPTO_12524",
"redirect_url": "https://thepayment.company",
"webhook_url": "https://thepayment.company/webhook",
"terminal_id": "T7244234",
}

Sample Responses

{
"status": "SUCCESS",
"message": "Payment processed successfully",
"redirect_url": "https://example.com/success",
"data": {
  "amount": 100.50,
  "currency": "USD",
  "order_id": "ORD123456",
  "transaction_id": "TXN789012",
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com"
  },
  "refund": {
    "status": false,
    "refund_date": null
  },
  "crypto_currency": "BTC",
  "crypto_network": "BITCOIN",
  "crypto_payment_status": "FULLPAID",
  "crypto_amount": 0.0025,
  "crypto_paid_amount": 0.0025
}
}

Understanding Crypto Payment Status

The crypto_payment_status field in the response indicates the payment completion status for cryptocurrency transactions. It is used to determine whether the received amount exactly matches, falls below, or exceeds the requested amount.

Payment Status Values

{
  "crypto_payment_status": "FULLPAID"
}

Description: The customer paid the exact requested amount.

Implementation Notes

Important: Always check the crypto_payment_status field before fulfilling orders for cryptocurrency payments. Because of blockchain transaction characteristics, small variations in payment amounts can occur because of:

Network fees and gas prices
Exchange-rate fluctuations during transaction processing
Limitations in the user's wallet

Integration Notes

Encrypted payment APIs must use AES-256-CBC before transmitting sensitive fields. Authentication, headers, encryption steps, and sample implementations for Node.js, PHP, Python, and Java are documented in Integration Examples.

Crypto Pay-In API

On this page