Order maintenance objects

Order Maintenance

Name Description
Authorization Webservice authorization details
TransactionKey Sub object for identification of authorization/transaction used in Order management object
Invoicelines Sub object with order details used in capture and refund object
Capture Invoice details for capture
Refund Invoice details for refund
Order Management Additional details for order maintenance

Authorization

Field name Data type Description
authorizationtoken String Not used
securityhash String Not used
merchantId Integer Must match the ‘Business Partner ID’ provided by AfterPay (also called relation number).
PortefeuilleId Integer Must match the ‘Portefeuille’, provided by AfterPay
Password String Must match the ‘Password’ provided by AfterPay

Transactionkey

Field name Data type Description
Ordernumber String The merchant’s order number
parentTransactionreference String Transaction reference used by PSP/Merchant for authorization. (Field: parentTransactionreference)

Invoicelines

Field name Data Type Description Required Validation
articleDescription String Description of the article / item. YES Numbers are allowed.Maximum of  45 characters. Punctuations will be filtered from the description.
articleID String The SKU of the Business Partner YES Maximum 25 characters.
netunitprice Double Unitprice excluding VAT. Only submitted when the shop only uses prices excluding VAT.. Only use with consultation of AfterPay NO Amount is in eurocents with 2 decimals. Example 10010,20 (normal notation € 100,1020)
quantity Integer Quantity of the ordered items YES Integer value > 0
Maximum value 2147483647
unitprice Integer Unitprice including VAT YES Amount is in eurocents
vatcategory Integer VAT category YES 1:high category, 2:low category, 3:nul category, 4:no category, 5:middle category.

Capture

Field name Data Type Required Description
Extrafields Array of extrafields NO
Invoicelines Array of invoicelines NO with full capture
/
YES with partial capture
Invoice lines. Only required to submit with a partial capture. This field is not used with full captures.
invoicenumber String YES Invoicenumber. For Germany counts a limit length of 7 characters Validation [A-Za-z0-9_-]. For Netherlands counts a limit length of 20 characters.
Transactionreference String NO
/
YES for collecting PSP
Transaction reference. (Optional) (Max 25 characters, will be truncated if longer) (Mandatory for collecting PSP)
Capturedelaydays Integer NO Amount of days delay before sending the invoice. Not operational.
Shippingcompany String NO Name of the shipping company
Trackingnumber String NO Tracktrace number of the shipping
Transactionkey TransactionKey YES Reference to the original authorisation (order)

Refund

Field name Data Type Required Description
Extrafields Array of extra fields NO
Invoicelines Array of invoice lines NO with full capture
/
YES with partial capture
Refund rules. Only required with partial refunds. A refund rule always contains a negative amount.
invoicenumber String YES Invoice number. For Germany counts a limit length of 7 characters Validation [A-Za-z0-9_-]. For Netherlands counts a limit length of 20 characters.
Transactionreference String NO
/
YES for collecting PSP
Transaction reference. (Optional) (Max 25 characters, will be truncated if longer) (Mandatory for collecting PSP)
creditInvoicenNumber String NO Credit invoice number. (Optional)
Transactionkey Transaction Key YES Reference to original authorization (order)

Ordermanagement

Field name Data Type Required Description
Extrafields Array of extra fields NO
Invoicelines Array of invoice lines NO Not used
invoicenumber String NO Not used
Transactionreference String NO
/
YES for collecting PSP
Transaction reference. (Optional) (Max 25 characters, will be truncated if longer) (Mandatory for collecting PSP)
Transactionkey Transaction Key YES Reference to original authorization (order)