Incoming payments
Introduction
Notification sent on each new incoming payment to a receive address
🔄 Retries
Curra will try to notify you 10 times in case your server response status isn't 2xx
Setup
You can set your server URL on the notifications page to start receiving incomes notifications:
Webhook payload
method: POST
headers:
- content-type: application/json
- x-api-key: your_api_key
body:
possible variants of status
:
- "pending" - on each
confirmations
field update - "success" – income considered successfull, assets received and confirmed on the address
fields:
* - non-optional field
Key | Type | Description |
---|---|---|
id | string* | unique identifier |
toAddress |
value: string* uniqueId: string* meta: string |
value – receive address uniqueId - uniqueId provided on address creation, generated if not provided meta – meta provided on address creation |
id | string* | uniqie identifier |
fromAddresses | string*[] | sender addresses |
valueUnits | string* | payment amount in units |
value | string* | payment amount in decimal format |
blockchain | string* | available values at "API value" column here |
fromAddress | string* | sender address |
block | number* | block number in which payment was mined |
txHash | string* | trasaction hash |
confirmations | number* | blockchain confirmations count |
assetId | string* | asset id of a payment |
status |
string* "pending" or "success" or "failed" |
pending – payment is not confirmed yet success - payment confirmed on the address failed - transaction is dropped from the blockchain or execution failed |
subStatus | string* | blockchain-specific status, can be used in informational purposes |
statusDescription | string* | human-readable description of status field |
example of pending payment:
{
"id": 99,
"toAddress": {
"value": "0xf51eb0786cbdb8eb6e8175f0f32ecf90b04ceb84",
"uniqueId": "unique id you specified when address was created",
"meta": "meta you specified when address was created"
},
"value": "1.0",
"valueUnits": "1000000000000000000",
"blockchain": "ETHEREUM",
"fromAddresses": ["0x67b1d87101671b127f5f8714789c7192f7ad340e"],
"block": 171,
"txHash": "0x0b15d671d9fe9cfe110c2d3a03867cc0525f6aeee45fe21ff66d07e0fd38ef46",
"confirmations": 10,
"assetId": "asset-id-123-123",
"status": "pending",
"subStatus": "pending",
"statusDescription": "Waiting for confirmations"
}
example of success payment:
{
"id": 99,
"toAddress": {
"value": "0xf51eb0786cbdb8eb6e8175f0f32ecf90b04ceb84",
"uniqueId": "unique id you specified when address was created",
"meta": "meta you specified when address was created"
},
"value": "1.0",
"valueUnits": "1000000000000000000",
"blockchain": "ETHEREUM",
"fromAddresses": ["0x67b1d87101671b127f5f8714789c7192f7ad340e"],
"block": 171,
"txHash": "0x0b15d671d9fe9cfe110c2d3a03867cc0525f6aeee45fe21ff66d07e0fd38ef46",
"confirmations": 21,
"assetId": "asset-id-123-123",
"status": "success",
"subStatus": "deposited",
"statusDescription": "Deposited"
}