Payment links

Read a payment link

GET
/link/{link_id}/

The public view the payment page renders. It never contains your wallets or callback URL. redirect_url, with link_id and success_token added, is returned only once the link is paid.

Path Parameters

Response Body

The link.

application/json
  1. response
status?string
link_id?string
Formatuuid
kind?string
Value in"payment""deposit"
link_status?string

deposit links stay open unless disabled.

Value in"open""paid""expired""disabled"
value?string|null
currency?string|null
suggested_value?string|null
item_description?string|null
merchant_name?|

Not verified by NoncePay.

logo_url?|

Not verified by NoncePay.

Formaturi
coins?array<>
expires_at?|
Formatdate-time
paid_fiat?|

payment links: confirmed deposits, in currency.

outstanding_fiat?|

payment links: what is left to pay.

is_partial?boolean|null
redirect_host?|

Host of redirect_url.

redirect_url?|

Only once paid, with link_id and success_token added.

deposits?array<>

The last 10 deposits seen before the link expired or was disabled.

Example Request
curl -X GET 'https://api.noncepay.app/link/497f6eca-6276-4993-bfeb-53cbbbba6f08/'
Example Response
{  "status": "success",  "link_id": "02a2c2f0-9521-47cc-9615-2e177adeebac",  "kind": "payment",  "link_status": "open",  "value": "string",  "currency": "string",  "suggested_value": "string",  "item_description": "string",  "merchant_name": "string",  "logo_url": "http://example.com",  "coins": [    {      "ticker": "string",      "coin": "string",      "minimum_transaction_coin": "string"    }  ],  "expires_at": "2019-08-24T14:15:22Z",  "paid_fiat": "string",  "outstanding_fiat": "string",  "is_partial": true,  "redirect_host": "string",  "redirect_url": "string",  "deposits": [    {      "ticker": "string",      "coin": "string",      "amount_coin": "string",      "confirmations": 0,      "confirmations_required": 0,      "status": "seen"    }  ]}

Create a payment link GET

Returns a link to a hosted payment page. The customer picks a coin and pays a fresh address; every deposit is forwarded to your wallet and reported to your `callback` like a `/create/` payment. Give at least one `address_<family>`: the page offers every coin of the families you give a wallet for, or only `coins`. Limited to 30 requests a minute and 1,000 a day per IP.

Get the address to pay a link in one coin GET

Returns the link's address for this coin, the same on every call, and for a `payment` link the amount still due (at least the coin's minimum), quoted in the coin and locked for 15 minutes. The payment page calls it when the customer picks a coin.