PaymentService

General for almost all requests is that an invoice number (InvoiceNumber) is needed to handle the request. The invoice number is generated by Collector in the AddInvoice method and returned in the response. This invoice number needs to be stored (together with your order) for further request of that invoice, for example when handling returns. All methods available in the Collector Bank Payment Service API is presented below.

Invoice status

The invoice status type is an enumeration value. Defined values are:

  • On hold (0) - Collector has not yet approved the invoice.
  • Pending (1) - The invoice is approved by Collector and can be activated.
  • Activated (2) - The invoice is activated by partner. Collector has purchased the invoice.
  • Cancelled (3) - The invoice is cancelled and cannot be updated or activated.
  • Expired (4) - The invoice was not activated within the activation time.
  • Rejected (5) - The invoice is rejected by Collector.
  • Signing (6) - The invoice needs to be digitally signed by end customer before the invoice can be activated.
  • Strong Verification (7) - The invoice needs to be digitally signed by end customer before the invoice can be activated

BaseAddress

ParameterRequiredTypeMaxDescription
Firstnamestring50
Lastnamestring50
Address1string50Required in all countries but Norway
Address2string50
COAddressstring50
PostalCodestring50
Citystring50
CountryCodestring2

Address

ParameterRequiredTypeMaxDescription
Firstnamestring50
Lastnamestring50
CompanyNamestring200
Address1string50Required in all countries but Norway
Address2string50
COAddressstring50
PostalCodestring50
Citystring50
CountryCodestring2
Emailstring260The customer's email address
PhoneNumberstring20The customer's phone number. Should always contain countrycode (eg. +46 xxx xxx xxx).
MobilePhonestring20The customer's cell phone number. Should always contain countrycode (eg. +46 xxx xxx xxx).

InvoiceRow

ParameterRequiredTypeMaxDescription
ArticleIdxstring50The ArticleId of the product.
Descriptionxstring50The description of the product.
Quantityxint8The quantity of the product. 1-99999999 (0 not allowed)
UnitPricexdecimal6,2Price per unit incl. VAT.
VATxdecimal6,2VAT in per cent

ArticleList

ParameterRequiredTypeMaxDescription
ArticleIdxstring50The ArticleId of the product
Descriptionstring50The Description of the product
Quantityxstring8The quantity of the product
UnitPricexdecimal6,2Price per unit incl. VAT.

IntegrationIds

ParameterRequiredTypeMaxDescription
IntegrationIdxstring50The integration ID can be assigned to customers in order to uniquely identify customers (instead of using Civic reg no).
IntegrationId Descriptionxstring50A friendly description of the IntegrationId given. Shown on the invoice as the “buyer” instead of the IntegrationId value. Must be used in combination with IntegrationId. No separators should be used, for example: - , .

AuthorizedSignatory

Can only be used for company

ParameterRequiredTypeMaxDescription
Emailstring260Email to AuthorizedSignatory
RegistrationNumberstring12Reg. no for authorized signatory. If CompanyPersonalGuarantee is enabled, the reg. no in this parameter will be used as personal guarantee reg. no.
UsePersonalGuaranteebooleanBool to inform if personal guarantee is accepted by end customer.

Buyer

ParameterRequiredTypeMaxDescription
Firstnamestring50
Lastnamestring50
Emailstring256The customer's email address
PhoneNumberstring20The customer's phone number. Should always contain countrycode (eg. +46 xxx xxx xxx).
MobilePhonestring20The customer's cell phone number. Should always contain countrycode (eg. +46 xxx xxx xxx).
RegistrationNumberstring20The civic RegistrationNumber of the buyer