Renewals

Insert renewal order

post/api/Renewals

Request

  • Base URL: https://api2.globalfinreg.com (the document declares no server; this is the origin it was published from)
  • URL: https://api2.globalfinreg.com/api/Renewals
  • Auth: API key in header Authorization

Query parameters

b2BPriceKeyinteger

Headers

x-imp-useridstring

The userid of the user to impersonate. Will be ignored if the logged in user is not an admin user

Request body

amountnumber double nullable
vatIncludedboolean required
vatNumberstring nullable
vatCountrystring nullable
currencystring nullable
invoiceNumberstring nullable
orderIDstring uuid required
renewalOrderIDstring nullable
transactionCompleteboolean nullable
invoiceDatestring date-time nullable
dibsTransactNostring nullable
durationinteger required
urlstring nullable
languagestring nullable
renewalYearinteger
bankTransferboolean nullable
transactionDatestring date-time nullable
bulkPaymentboolean nullable
bankTransferTextstring nullable
invoicedboolean nullable
paymentProcessorstring nullable
confirmedboolean nullable
processedboolean nullable
leiNumberstring nullable
archivedboolean nullable
creditNoteboolean nullable
netsPaymentIDstring nullable
hostedPaymentPageboolean nullable

Card payments with NETS only: create a NETS hosted payment page instead of the website's embedded checkout, for payers who aren't on the website. The response is then {"paymentId": "...", "paymentUrl": "..."}, and Gfr.Api.Models.Renewal.RenewalShort.Url is the website the payer returns to.

Response

renewal order Created

Changes

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