Parameters
Parameter | Value | Parameter Type | ||
---|---|---|---|---|
paymentRequest |
{ "order":{ "items":[ { "reference":string, "name":string, "quantity":decimal, "unit":string, "unitPrice":int, "taxRate":int, "taxAmount":int, "grossTotalAmount":int, "netTotalAmount":int } ], "amount":int, "currency":string, "reference":string }, "checkout":{ "url":string, "termsUrl":string, "consumerType":{ "supportedTypes":[ "B2C", "B2B" ], "default":"B2C" }, "publicDevice":bool, "charge":bool }, "paymentMethods":[ { "name":"easyinvoice", "fee":{ "reference":string, "name":string, "quantity":decimal, "unit":string, "unitPrice":int, "taxRate":int, "taxAmount":int, "grossTotalAmount":int, "netTotalAmount":int } } ], "webHooks":[ { "eventName":"payment.refund.completed", "url":URL, "authorization":string } ] } |
body |
About the parameters
- order
- items - Order item - Multiple order items can be added (mandatory)
- reference - Product reference (mandatory)
- name - Product name (mandatory)
- quantity - Product quantity (mandatory)
- unit - Product unit, for instance pcs or Kg (mandatory)
- unitPrice - Product price per unit (mandatory)
- taxRate - Product tax rate (mandatory)
- taxAmount - Product tax/VAT amount (mandatory)
- grossTotalAmount - Product total amount including VAT (mandatory)
- netTotalAmount - Product total amount excluding VAT (mandatory)
- amount - Total amount of the payment (mandatory)
- currency - Currency of the payment (mandatory)
- reference - Payment reference (mandatory)
- items - Order item - Multiple order items can be added (mandatory)
- checkout - Information that Easy need to initialize the window
- url - The URL of where the checkout should initialize on (mandatory)
- termsUrl - The URL to your terms and conditions (mandatory)
- shippingCountries - Limits the shipping countries (optional)
- countryCode - Shipping country ISO code, see Datastring Parameters
- consumerType - Configures which consumers types should be accepted (optional, will default to B2C if not entered)
- supportedTypes - B2C and/or B2B
- default - Sets the default consumer type
- publicDevice - Default value = false, if set to true the checkout will not load any user data.
- charge - Default value = false, if set to true the transaction will be charged automatically after reservation have been accepted without calling the Charge API.
- paymentMethods -
- name -
- fee -
- reference -
- name -
- quantity -
- unit -
- unitPrice -
- taxRate -
- taxAmount -
- grossTotalAmount -
- netTotalAmount -
- notifications - Used to get the status of a transaction (optional)
- webhooks - List of webhooks the merchant wants to register for the payment. Maximum number of webhooks is 32.
- eventName - Input the event you want to listen for
- url - The callback is sent to this url on the merchant site. Must be https. Maximum length is 256 characters.
- authorization - Header of the callback sent to the merchant site will be set to this value. Must be between 8 and 32 characters long and alphanumeric.
- webhooks - List of webhooks the merchant wants to register for the payment. Maximum number of webhooks is 32.