This endpoint represents all payment-related operations that are part of validated transactions. This endpoint can also be used in streaming mode so it is possible to use it to listen for new payments as they get made in the HCNet. If called in streaming mode Aurora will start at the earliest known payment unless a cursor is set. In that case it will start from the cursor. You can also set cursor value to now to only stream payments created since your request time.
The operations that can be returned in by this endpoint are:
GET /payments{?cursor,limit,order}
Arguments
| Name | Notes | Description | Example |
|---|---|---|---|
| ?cursor | optional,any, default null | A paging token, specifying where to start returning records from. When streaming this can be set to now to stream object created since your request time. | 12884905984 |
| ?order | optional, string, default asc | The order in which to return rows, “asc” or “desc”. | asc |
| ?limit | optional, number, default: 10 | Maximum number of records to return. | 200 |
Response
This endpoint responds with a list of payments. See operation resource for more information about operations (and payment operations).
Example Streaming Event
{
"_links" : {
"effects" : {
"href" : "/operations/77309415424/effects/{?cursor,limit,order}",
"templated" : true
},
"precedes" : {
"href" : "/operations?cursor=77309415424&order=asc"
},
"self" : {
"href" : "/operations/77309415424"
},
"succeeds" : {
"href" : "/operations?cursor=77309415424&order=desc"
},
"transactions" : {
"href" : "/transactions/77309415424"
},
"account" : "GBIA4FH6TV64KSPDAJCNUQSM7PFL4ILGUVJDPCLUOPJ7ONMKBBVUQHRO",
"funder" : "GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ",
"id" : 77309415424,
"paging_token" : "77309415424",
"starting_balance" : 1e+14,
"type_i" : 0,
"type" : "create_account"
}
# Retrieve the first 200 payments, ordered chronologically.
curl "https://network.paybito.com/payments?limit=200"
# Retrieve a page of payments to occur immediately before the transaction
# specified by the paging token "1234".
"_links" : {
"self" : {
"href" : "/payments?cursor=\u0026limit=200\u0026order=asc"
},
"next" : {
"href" : "/payments?cursor=1563350915878913\u0026limit=200\u0026order=asc"
},
"prev" : {
"href" : "/payments?cursor=47184510717953\u0026limit=200\u0026order=desc"
},
{
"_embedded" : {
"records" : [
{
"_links" : {
"effects" : {
"href" : "/operations/47184510717953/effects",
"templated" : true
},
"precedes" : {
"href" : "/effects?order=asc\u0026cursor=47184510717953"
},
"self" : {
"href" : "/operations/47184510717953"
},
"succeeds" : {
"href" : "/effects?order=desc\u0026cursor=47184510717953"
},
"transactions" : {
"href" : "/transactions/6558ca87a30140492eaa8a88572d45fb2728ebbc1eccf48f2dc6ddfe8cae2d79"
}
},
"account" : "GB55ZCH6WXZLJRUP3J36NHZSMIPNW24LZNGAOOLMFTJTIRZCCSUTY7XW",
"funder" : "GBXVKIPRDNPTXA6R6OREEY3GDFDUUR6MTY7XKBO62QVXRG4ZQBAMWMEO",
"id" : 47184510717953,
"paging_token" : "47184510717953",
"starting_balance" : 100000.0000000,
"created_at" : "2018-12-20T06:44:24Z",
"transaction_hash" : "6558ca87a30140492eaa8a88572d45fb2728ebbc1eccf48f2dc6ddfe8cae2d79",
"type_i" : 0,
"type" : "create_account"
},
{
"_links" : {
"effects" : {
"href" : "/operations/47188805685249/effects",
"templated" : true
},
"precedes" : {
"href" : "/effects?order=asc\u0026cursor=47188805685249"
},
"self" : {
"href" : "/operations/47188805685249"
},
"succeeds" : {
"href" : "/effects?order=desc\u0026cursor=47188805685249"
},
"transactions" : {
"href" : "/transactions/450a34e1c10d2d11bf4c2111b71bcf97f6b9d6107eb0d4d3b58670e6e9e1c137"
}
},
"account" : "GC5GGY6HZHBLIQWM6XKCT4ELWKJHWV37FIGD5PTJQCO7TBMZ6A6NQIMO",
"funder" : "GBXVKIPRDNPTXA6R6OREEY3GDFDUUR6MTY7XKBO62QVXRG4ZQBAMWMEO",
"id" : 47188805685249,
"paging_token" : "47188805685249",
"starting_balance" : 100000.0000000,
"created_at" : "2018-12-20T06:44:29Z",
"transaction_hash" : "450a34e1c10d2d11bf4c2111b71bcf97f6b9d6107eb0d4d3b58670e6e9e1c137",
"type_i" : 0,
"type" : "create_account"
}