BiglyPay API & Integration

Overview

BiglyPay offers a non‑custodial crypto payment gateway API, enabling merchants to process blockchain payments without holding customer funds. Integrations are handled via our remote checkout endpoint (https://biglypay.com/remote_payment.php), and our callback system notifies you upon payment confirmation.

Authentication

Every API call must include and validate your API key, domain or IPN key.


apiKey: YOUR_API_KEY
ipn_key: YOUR_IPN_KEY
domain: yourdomain.com

These parameters ensure that your requests are authenticated and secure. Retrieve your API and IPN keys in your account settings.

Checkout Integration

This is the primary endpoint for third‑party integrations. Use https://biglypay.com/remote_payment.php to initiate payments.

Endpoint: POST /remote_payment.php

Required POST Parameters:

invoiceid (integer): The invoice ID.
amount (number): Invoice amount in USD.
domain (string): Your domain host (without http://, https:// or trailing /).
email (string): Customer’s email address.
apiKey (string): Your API key.
userid (integer): The customer’s user ID.
returnurl (string): The URL to return to after payment.
logo (string, optional): Your company logo URL.

Example Request (POST):


POST /remote_payment.php
Content-Type: application/x-www-form-urlencoded

invoiceid=67890
&amount=150.00
&domain=yourdomain.com
&email=customer@example.com
&apiKey=YOUR_API_KEY
&userid=12345
&returnurl=https%3A%2F%2Fyourdomain.com%2Fviewinvoice.php%3Fid%3D67890
&logo=https%3A%2F%2Fyourdomain.com%2Flogo.png

Response Parameters:

The API responses include the following parameters:

invoice_id: A unique identifier generated by BiglyPay for the invoice.
related_invoice_id: The original invoice ID provided by your system.
destination_address: The wallet address where the customer should send payment, based on your merchant settings.
token_symbol: The token symbol to be used for payment (e.g., BTC, ETH, TRX, SOL, BASE).
total_required_amount: The total token amount required to cover the invoice amount plus fee.
action: Indicates whether the invoice was newly created or an existing invoice was updated.

Example Response:


{
  "invoice_id": 101,
  "related_invoice_id": 67890,
  "destination_address": "MerchantWalletAddress",
  "token_symbol": "BTC",
  "total_required_amount": 0.00543210,
  "action": "created"
}

Callback Integration

After a payment is confirmed, BiglyPay sends a callback (IPN) to your system. The callback payload includes the following parameters:

invoice_id The ID for invoice on BiglyPay Side.
related_invoice_id The original invoice ID provided by your system.
status The payment status (e.g., "Confirmed", "Partially Paid", or "Expired").
tx_hash The blockchain transaction hash associated with the payment.
received_amount The amount of USD received.
ipn_key The key used for callback authentication, verify it to match the key set in your BiglyPay settings to validate that call came from BiglyPay system.

Example Callback Payload:


{
  "invoice_id": 101,
  "related_invoice_id": 67890,
  "status": "Confirmed",
  "tx_hash": "abcd1234...",
  "received_amount": 5.5,
  "ipn_key": "YOUR_IPN_KEY"
}

Error Codes

BiglyPay uses standard HTTP status codes:

200 OK – The request was successful.

400 Bad Request – Missing or invalid parameters.

403 Forbidden – Authentication failed (invalid API/IPN key).

405 Method Not Allowed – Incorrect HTTP method.

500 Internal Server Error – An unexpected error occurred.

FAQ

Q: How do I get my API and IPN keys?

A: They are available in your account settings on BiglyPay after registration.

Q: What does non-custodial mean?

A: Your funds are sent directly from your customer's wallet to your merchant wallet. BiglyPay does not hold your funds.