COconfirmo
Invoice

Create Take Request for expired Invoice

Places a Take Request for an Invoice that has expired. A Take Request is a process that allows accepting an underpaid Invoice as paid after its expiration.

post/v3/invoices/{id}/take

Request

  • Base URL
    https://confirmo.net/api
  • URL
    https://confirmo.net/api/v3/invoices/{id}/take
  • Auth
    HTTP bearer

Path parameters

idstring required

The Invoice ID

Response

Take request successfully created

customerCurrencystring

The currency in which the customer is supposed to pay.

expirationinteger

The timestamp when take offer expires.

expirationDurationinteger

The number of seconds before take offer expires.

merchantCurrencystring
offeredAmountInMerchantCurrencynumber
offeredPricenumber

The new price of crypto currency.

offeredSettlementAmountnumber

The new amount to be settled (after take).

originalSettlementAmountnumber

The original amount to be settled (before take)

refundAmountnumber

Used for internal purposes

settlementCurrencystring

The currency of the Settlement Method.

takenboolean

True if the Invoice was taken.

takenAtinteger

The take action timestamp as Unix timestamp.

Example response

{
  "customerCurrency": "LTC",
  "expiration": 1552987955,
  "expirationDuration": 120,
  "offeredSettlementAmount": 3198,
  "settlementCurrency": "EUR",
  "taken": true,
  "takenAt": 1552987719
}

Changes

No recorded changes to this operation across all 1 revision of this API.