Schemas used in requests/responses of our API:

invoice

ParameterTypeDescriptionConstraintsRequired
referenceString(1...255)An identifier specified by you. If webhooks were specified in the request this identifier is added to the webhook request payload.
amountInt(1...99999999)Integer representing the total amount of the transaction. Denomination in the smallest currency subunit (e.g. eurocents).>= 5000 cents
descriptionString(1...255)Description of the transaction. Ultimately appears on the payment confirmation (statement and confirmation screen).

consumer

ParameterTypeDescriptionConstraintsRequired
namename ObjectCustomer name.
phoneStringCustomer phone number.
emailStringEmail provided by customer.
dateOfBirthStringDate of birth of the customer.
shippingAddressaddress ObjectShipping address.
invoiceAddressaddress ObjectInvoice address.
businessbusiness ObjectThis feature is used when the one making the purchase is a business. If you decide to use this feature please inform us so that we can ask IN3 activate B2B functionality for your IN3 account.nullable

name

ParameterTypeDescriptionConstraintsRequired
initialsString(1...20)Customer name initials.
lastNameString(1...250)Customer last name.

address

ParameterTypeDescriptionConstraintsRequired
addressedToString(1...250)The name or entity which shall accept the package/invoice.
streetString(1...128)Street.
houseNumberString(1...25)House number.
houseNumberSuffixString(1...25)House number suffix.
postalCodeString(1...25)Postal code.
cityString(1...128)City.
countryCodeStringCountry code.ISO 3166-1 country code.
stateString(1...40)State.

business

ParameterTypeDescriptionConstraintsRequired
nameString(1...35)The name of the purchasing business.
lastNameString(1...250)The Chamber of Commerce number of the business.

item

ParameterTypeDescriptionConstraintsRequired
codeString(1...50)A code that identifies the item.
nameString(1...50)A human readable name for the item.
descriptionString(1...100)Item description.
unitPriceInt(1...99999999)Unit price (including VAT) of the item, specified in the smallest currency subunit, as for example eurocents.
quantityInt(1...1000000000)The number of items.
vatAmountInt(1...99999999)VAT amount of one unit, specified in the smallest currency subunit, as for example eurocents.
vatRateNumber(0...99.9)Percentage of VAT applied. Only the first decimal value will be taken into account, the rest will be ignored.

action

ParameterTypeDescriptionConstraintsRequired
redirectredirect ObjectNext action to be performed by merchant (or consumer) to complete the payment.

redirect

ParameterTypeDescriptionConstraintsRequired
urlStringURL where consumer should be redirected to by the merchant to perform the payment.

returnUrls

ParameterTypeDescriptionConstraintsRequired
successString(1...2000)Return URL to use when the transaction succeeds.
cancelledString(1...2000)Return URL to use when the transaction is cancelled.
expiredString(1...2000)Return URL to use when the transaction is expired.
failedString(1...2000)Return URL to use when the transaction is failed.

refund

ParameterTypeDescriptionConstraintsRequired
idString(36)Refund unique identifier.
transactionIdString(36)Unique identifier of the transaction related to this refund.
amountInt(1...99999999)Refund amount. Denomination in the smallest currency subunit (e.g. eurocents).
reasonString(255)The description for the refund.
createdString(RFC3339)Creation time.ISO 8601 date and time.
updatedString(RFC3339)Updated time.ISO 8601 date and time.