Developer
DocsDeveloperPlatformTicket
Search
⌃K
Links

Invoice

The invoice contains all order/invoice information.
ExampleKey
Type
Description
number
string
Comma separated product names
products
array
Products as array with -name: string -price: float -quantity: integer -sku: string (see changelog) -vatRate: float (see changelog)
amount
float
The total amount paid
discount
array
(optional) Information about discount -code: string -amount: float -percentage: integer (optional)
currency
string
​ISO 4217 of currency
test
boolean
Payment has been processed in sandbox
referenceId
string
reference code passed through API or GET parameter to the payment page
paymentRequestId
id
ID of the Invoice or Payrexx Gateway created through API
paymentLink
array
Invoice / Gateway data as array -hash -referenceId -email
custom_fields
array
All fields passed in the form in the shopper's language as array -name -value

Example

<?php
array(
'number' => 'Product 1, Product 2',
'products' => array(
0 => array(
'name' => 'Product 1',
'price' => 2.9,
'quantity' => 1,
'sku' => '01120001',
'vatRate' => 8,
),
1 => array(
'name' => 'Product 2',
'price' => 1.9,
'quantity' => 1,
'sku' => '01120000',
'vatRate' => 7.7,
),
),
'amount' => 4.8,
'discount' => array(
'code' => NULL,
'amount' => 0,
'percentage' => NULL,
),
'currency' => 'CHF',
'test' => 0,
'referenceId' => '',
'paymentRequestId' => NULL,
'paymentLink' => NULL,
'custom_fields' => array(
1 => array(
'name' => 'Field 1 name',
'value' => 'Field 1 value',
),
2 => array(
'name' => 'Field 2 name',
'value' => 'Field 2 value',
),
3 => array(
'name' => 'Field 3 name',
'value' => 'Field 3 value',
),
),
);
Previous
Metadata
Next
Contact
Last modified 2yr ago