0.0.2
Welcome to Procuret .NET. This initial release provides the InstalmentLink
struct. InstalmentLink
facilitates the creation of customised links to the Procuret Instalment Product (PIP). PIP allows a customer Business to pay for a purchase over time, while you the Supplier are paid upfront.
When you create an InstalmentLink
, you can ask Procuret to send an email to the customer Business on your behalf.
Methods
static async Task<String>.create(...)
Parameters
Int64
supplierId - Your unique Supplier IDString
customerEmail - The email of the customer to whom a Procuret
payment invitation email should be sent.String
invoiceIdentifier - Your invoice identifier. E.g."INV-001"
Decimal
invoiceValue - The amount payable by the customerCommunicationOption
communication - Instance ofCommunicationOption
enumerationSession
session - TheSession
to use when authenticating your request
Example Usage
await InstalmentLink.create(
supplierId: 589121125121,
customerEmail: "[email protected]",
invoiceIdentifier: "INV-001",
invoiceValue: Convert.ToDecimal("422.22"),
communciation: CommunicationOption.NotifyCustomer,
session: session // See Session create example above
)
At present, InstalmentLink
does not return anything useful. The String
returned at task completion contains the raw JSON response from Procuret API.
You can expect a more useful return value in future versions of Procuret .NET.