Payments

Payment callback

Sent to your callback URL. With pending=1, once when the payment is first seen (pending=1), then once it is forwarded (pending=0). By default every field is in the query string; with post=1 it is a form body, with json=1 a JSON body. Your own callback query parameters are always kept.

Answer 200 with the body *ok* within 30 seconds; anything else is retried at 6, 12, 24 minutes and so on until the payment is 3 days old. Verify x-ca-signature (base64 RSA-SHA256 PKCS#1 v1.5 of the full URL for GET, of the raw body for POST) with the key from /pubkey/.

Header Parameters

x-ca-signature*string

Request Body

application/json
  1. body

Fields sent to your callback URL, in this order.

uuid?string

Same on the pending and confirmed callback of one payment; use it to deduplicate.

address_in?string
address_out?string
confirmations?string
txid_in?string
txid_out?string

Confirmed callback only.

fee?stringDeprecated
fee_coin?string

Our fee, confirmed callback only.

value?stringDeprecated
value_coin?string

Amount paid by your customer.

value_forwarded?stringDeprecated
value_forwarded_coin?string

Amount sent to your wallet, confirmed callback only.

value_coin_convert?string

With convert=1: JSON object of fiat values.

value_forwarded_coin_convert?string
coin?string
price?string

Coin price in USD.

result?string
Value in"pending""sent"
pending?string
Value in"0""1"

Response Body

Your server acknowledges with the body *ok*.

response?stringtext/plain
Example Requests
GET/paymentCallback

Fields sent to your callback URL, in this order.

Header Parameters
{  "x-ca-signature": "string"}