Home > API > Order Management > Order

Order

Returns the contents of the specified order

PATH:

/api/v3/orders/{orderNumber}

PATH PARAMETERS:

orderNumber
required

string

Order number

RESPONSES:

200 OK

RESPONSE SCHEMA:

orderDetails

orderDetails object

Order details

orderId

string

Order ID

orderNumber

string <= 50 characters

Order number

totalNetAmount

number

Total net amount of order

totalGrossAmount

number

Total gross amount of order

currency

string

Enum: EUR NOK SEK DKK CHF

Order currency

orderChannelType

string

Enum: Internet Catalog CallCenter Stationary Other

Order channel type

orderDeliveryType

string

Enum: Normal Express

Order delivery type

hasSeparateDeliveryAddress

boolean

Indicates whether order has separate delivery address or not

customer

customer object

Customer information

customerNumber

string <= 100 characters

Customer unique number

identificationNumber

string <= 20 characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

salutation

string

Enum: Mr Mrs Miss

Salutation.

firstName
required

string <= 50 characters

First name. Everything over 50 characters will be truncated

lastName
required

string <= 50 characters

Last name. Everything over 50 characters will be truncated

companyName

string <= 50 characters

Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.

email
required

string <= 255 characters

Email

phone

string <= 20 characters

Phone

mobilePhone

string <= 20 characters

Mobile phone

birthDate
required

string

Date of birth. Format is 'YYYY-MM-DD'. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum: Company Person

Customer category.

address
required

address object

Address

street
required

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode
required

string <= 10 characters

Postal code

postalPlace
required

string <= 100 characters

Postal place

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

riskData
required

riskData object

Risk related data. Merchants can do external risk checks and provide that information to AfterPay.

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string <= 255 characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum: NotSet Advertisment SocialNetwork Direct SearchEngine Other

Specify the channel which consumer has used for accessing merchant page

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member). For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string <= 50 characters

Unique Id of the device for profile tracking

ipAddress
required

string <= 39 characters

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant. Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string <= 4096 characters

UserAgent of this specific consumer

conversationLanguage

string

Enum: NO SV SE FI DA DK EN DE NL FR

Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.

distributionType

string

Enum: Paper Email Sms

Specifies how information (invoices, notices, etc.) will be distributed to customer.

vatId

string <= 50 characters

VAT registration number, the unique number that identifies a business. VatId is a mandatory field for processing B2B transactions for Germany.

insertedAt

string

Indicates the creation of the specific element (e.g. orderDetails)

updatedAt

string

Indicates the time of the latest change of the element

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay,on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.

merchantImageUrl

string <= 2048 characters

Image URL for the merchants brand. This image is shown at the top of the order page in MyAfterPay

googleAnalyticsUserId

string <= 50 characters

Google Analytics User ID

orderItems

array of orderItems

Order items

Array () [
orderId

string

Order ID

insertedAt

string

Inserted at

updatedAt

string

Updated at

productId
required

string <= 100 characters

Merchant Product identification number

groupId

string <= 50 characters

Item group ID. The group this item belongs to. Provided by the merchant

description
required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated

type

string

Enum: PhysicalArticle DigitalArticle GiftCard Discount ShippingFee Surcharge Info

Order item type

netUnitPrice
required

number

Net unit price

grossUnitPrice
required

number

Gross price per item

quantity
required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

unitCode

string <= 50 characters

Unit code (for example pieces, liters, kilograms, etc.)

vatCategory

string

Enum: HighCategory LowCategory NullCategory NoCategory MiddleCategory OtherCategory

VAT category

vatPercent
required

number

Tax percent

vatAmount
required

number

Tax amount per item

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.

googleProductCategoryId

integer

Google product category ID

googleProductCategory

string <= 255 characters

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results

merchantProductType

string <= 255 characters

Categorization used by Merchant as a complement to Google Taxonomy

lineNumber

integer

Line number. The merchant may add a line number to each order item, to sort them in a particular order

productUrl

string <= 2048 characters

URL to the product

marketPlaceSellerId

string <= 32 characters

ID of an individual seller on a marketplace

parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalInformation

string <= 4096 characters

Extended description of the order item.


]
expirationDate

string

The date and time when this authorization will expire if you did not make a Capture call.If the deadline has passed, you must make a new Authorize call before Capturing this order.

status

string

Enum: Accepted Cancelled Expired Pending

Order status

displayStatus

string

Enum: Reserved Cancelled FullyCaptured PartiallyCaptured PartiallyRefunded FullyRefunded Expired

Display status

captures

array of captures

Collection of captures

Array () [
reservationId

string

Reservation ID

customerNumber

string <= 100 characters

Customer number

captureNumber

string <= 50 characters

Capture number

orderNumber

string <= 50 characters

Order number

amount

number

Shows the original invoice amount

balance

number

Shows the remaining amount due on the invoice

totalRefundedAmount

number

Total refunded amount

currency

string

Enum: EUR NOK SEK DKK CHF

Currency code

insertedAt

string

Indicates the capture creation time

updatedAt

string

Indicates the time when the capture was last updated

directDebitBankAccount

string <= 34 characters

Direct debit bank account

directDebitSwift

string <= 11 characters

Direct debit swift

accountProfileNumber

integer

Account profile number

numberOfInstallments

integer

Number of installments

installmentAmount

number

Installment amount

contractDate

string

Contract date

orderDate

string

Order date

installmentProfileNumber

integer

Installment profile number

parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.

transactionReference

string <= 100 characters

A unique reference for each transaction (separate for transactions within an order),generated and provided to AfterPay by a third party (merchant or Payment Service Provider). It is used to identify transactions during back-end settlement between Core systems and the PSP.

dueDate

string

Due date

invoiceDate

string

Invoice date

yourReference

string <= 20 characters

Reference number. Only to be used if advised by AfterPay integration manager

ourReference

string <= 20 characters

Reference number. Only to be used if advised by AfterPay integration manager

invoiceProfileNumber

integer

Invoice profile number

ocr

string <= 27 characters

OCR (Optical Character Recognition) number bound to this capture

installmentCustomerInterestRate

number

Installment customer interest rate

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay,on the invoice line next to the order item. The linked image must be a rectangle or square,width between 100 pixels and 1280 pixels.

captureItems

array of captureItems

Capture items

Array () [
productId
required

string <= 100 characters

Merchant Product identification number

groupId

string <= 50 characters

Item group ID. The group this item belongs to. Provided by the merchant

description
required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated

type

string

Enum: PhysicalArticle DigitalArticle GiftCard Discount ShippingFee Surcharge Info

Order item type

netUnitPrice
required

number

Net unit price

grossUnitPrice
required

number

Gross price per item

quantity
required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

unitCode

string <= 50 characters

Unit code (for example pieces, liters, kilograms, etc.)

vatCategory

string

Enum: HighCategory LowCategory NullCategory NoCategory MiddleCategory OtherCategory

VAT category

vatPercent
required

number

Tax percent

vatAmount
required

number

Tax amount per item

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.

googleProductCategoryId

integer

Google product category ID

googleProductCategory

string <= 255 characters

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results

merchantProductType

string <= 255 characters

Categorization used by Merchant as a complement to Google Taxonomy

lineNumber

integer

Line number. The merchant may add a line number to each order item, to sort them in a particular order

productUrl

string <= 2048 characters

URL to the product

marketPlaceSellerId

string <= 32 characters

ID of an individual seller on a marketplace

parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalInformation

string <= 4096 characters

Extended description of the order item.


]
shippingDetails

array of shippingDetails

Shipping details

Array () [
shippingNumber
required

integer

Unique shipping number within one capture

type
required

string

Enum: Shipment Return

Shipping type

shippingCompany
required

string <= 200 characters

Company name providing shipping

trackingId
required

string <= 100 characters

Tracking ID

trackingUrl

string <= 2083 characters

Webpage URL to track shipping status


]

]
refunds

array of refunds

Collection of refunds

Array () [
reservationId

string

Reservation ID

customerNumber

string <= 100 characters

Customer number

refundNumber

string <= 50 characters

Refund number

orderNumber

string <= 50 characters

Order number

amount

number

Refunded amount

balance

number

Remaining amount to be refunded

currency

string

Enum: EUR NOK SEK DKK CHF

Currency code

insertedAt

string

Indicates the Refund creation time

updatedAt

string

Indicates the time when the refund was last updated

captureNumber

string <= 50 characters

Capture number

refundItems

array of refundItems

Refund items

Array () [
productId
required

string <= 100 characters

Merchant Product identification number

groupId

string <= 50 characters

Item group ID. The group this item belongs to. Provided by the merchant

description
required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated

type

string

Enum: PhysicalArticle DigitalArticle GiftCard Discount ShippingFee Surcharge Info

Order item type

netUnitPrice
required

number

Net unit price

grossUnitPrice
required

number

Gross price per item

quantity
required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

vatCategory

string

Enum: HighCategory LowCategory NullCategory NoCategory MiddleCategory OtherCategory

VAT category

vatPercent
required

number

Tax percent

vatAmount
required

number

Tax amount per item

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.

googleProductCategoryId

integer

Google product category ID

googleProductCategory

string <= 255 characters

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results

merchantProductType

string <= 255 characters

Categorization used by Merchant as a complement to Google Taxonomy

productUrl

string <= 2048 characters

URL to the product

marketPlaceSellerId

string <= 32 characters

ID of an individual seller on a marketplace

additionalInformation

string <= 4096 characters

Extended description of the order item.


]
parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.

transactionReference

string <= 100 characters

Transaction-specific reference from and for the PSP's system


]
cancellations

array of cancellations

Cancellation info

Array () [
cancellationNo

string <= 50 characters

Order number

cancellationAmount

number

Amount of the cancelled items

cancellationItems

array of cancellationItems

The list of items to be cancelled

Array () [
cancellationNumber

string <= 50 characters

Refund ID

productId
required

string <= 100 characters

Merchant Product identification number

groupId

string <= 50 characters

Item group ID. The group this item belongs to. Provided by the merchant

description
required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated

type

string

Enum: PhysicalArticle DigitalArticle GiftCard Discount ShippingFee Surcharge Info

Order item type

netUnitPrice
required

number

Net unit price

grossUnitPrice
required

number

Gross price per item

quantity
required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

unitCode

string <= 50 characters

Unit code (for example pieces, liters, kilograms, etc.)

vatCategory

string

Enum: HighCategory LowCategory NullCategory NoCategory MiddleCategory OtherCategory

VAT category

vatPercent
required

number

Tax percent

vatAmount
required

number

Tax amount per item

imageUrl

string <= 2048 characters

URL for the image of this product. It will be turned into a thumbnail and displayed in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.

googleProductCategoryId

integer

Google product category ID

googleProductCategory

string <= 255 characters

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results

merchantProductType

string <= 255 characters

Categorization used by Merchant as a complement to Google Taxonomy

lineNumber

integer

Line number. The merchant may add a line number to each order item, to sort them in a particular order

productUrl

string <= 2048 characters

URL to the product

marketPlaceSellerId

string <= 32 characters

ID of an individual seller on a marketplace

parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalInformation

string <= 4096 characters

Extended description of the order item.


]
parentTransactionReference

string <= 128 characters

A unique reference provided to AfterPay by a third party (merchant or Payment Service Provider). Identifies an entire order.


]
payment

payment object

Payment details

type
required

string

Enum: Invoice Account Installment Consolidatedinvoice DirectDebitInvoice

Payment method

contractId

string

Contract ID

directDebit

directDebit object

Direct debit information

bankCode

string <= 11 characters

Direct debit swift, BIC, SortCode

bankAccount
required

string <= 34 characters

Direct debit bank account

token

string <= 50 characters

Unique string provided by AfterPay if the merchant is using tokenization.Contact your Integration Manager for more details.

campaign

campaign object

Campaign information

campaignNumber
required

integer

Campaign number

invoice

undefined

Invoice information. Reserved for future use.

account

account object

Used when consumer has chosen flexible installment plan (minimum amount to pay)

profileNo
required

integer

Account Profile number

consolidatedInvoice

consolidatedInvoice object

Consolidate invoice information

invoiceDate

string

Date when invoice will be created

installment

installment object

Installment information

profileNo
required

integer

Installment profile number

numberOfInstallments

integer

Number of installments

customerInterestRate

number

Customer interest rate

400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

get

/api/v3/orders/{orderNumber}

Response samples

200400
  • {
    • "orderDetails": { ...
      • "orderId": "string",
      • "orderNumber": "string",
      • "totalNetAmount": 1.00,
      • "totalGrossAmount": 1.00,
      • "currency": "string",
      • "orderChannelType": "string",
      • "orderDeliveryType": "string",
      • "hasSeparateDeliveryAddress": true,
      • "customer": { ...
        • "customerNumber": "string",
        • "identificationNumber": "string",
        • "salutation": "string",
        • "firstName": "string",
        • "lastName": "string",
        • "companyName": "string",
        • "email": "string",
        • "phone": "string",
        • "mobilePhone": "string",
        • "birthDate": "string",
        • "customerCategory": "string",
        • "address": { ...
          • "street": "string",
          • "streetNumber": "string",
          • "streetNumberAdditional": "string",
          • "postalCode": "string",
          • "postalPlace": "string",
          • "countryCode": "string",
          • "careOf": "string"
          },
        • "riskData": { ...
          • "existingCustomer": true,
          • "verifiedCustomerIdentification": true,
          • "marketingOptIn": true,
          • "customerSince": "string",
          • "customerClassification": "string",
          • "acquisitionChannel": "string",
          • "hasCustomerCard": true,
          • "customerCardSince": "string",
          • "customerCardClassification": "string",
          • "profileTrackingId": "string",
          • "ipAddress": "string",
          • "numberOfTransactions": 1,
          • "customerIndividualScore": "string",
          • "userAgent": "string"
          },
        • "conversationLanguage": "string",
        • "distributionType": "string",
        • "vatId": "string"
        },
      • "insertedAt": "string",
      • "updatedAt": "string",
      • "imageUrl": "string",
      • "merchantImageUrl": "string",
      • "googleAnalyticsUserId": "string",
      • "orderItems": [ ...
        • {
          • "orderId": "string",
          • "insertedAt": "string",
          • "updatedAt": "string",
          • "productId": "string",
          • "groupId": "string",
          • "description": "string",
          • "type": "string",
          • "netUnitPrice": 1.00,
          • "grossUnitPrice": 1.00,
          • "quantity": 1.00,
          • "unitCode": "string",
          • "vatCategory": "string",
          • "vatPercent": 1.00,
          • "vatAmount": 1.00,
          • "imageUrl": "string",
          • "googleProductCategoryId": 1,
          • "googleProductCategory": "string",
          • "merchantProductType": "string",
          • "lineNumber": 1,
          • "productUrl": "string",
          • "marketPlaceSellerId": "string",
          • "parentTransactionReference": "string",
          • "additionalInformation": "string"
          }
        ],
      • "expirationDate": "string",
      • "status": "string",
      • "displayStatus": "string"
      },
    • "captures": [ ...
      • {
        • "reservationId": "string",
        • "customerNumber": "string",
        • "captureNumber": "string",
        • "orderNumber": "string",
        • "amount": 1.00,
        • "balance": 1.00,
        • "totalRefundedAmount": 1.00,
        • "currency": "string",
        • "insertedAt": "string",
        • "updatedAt": "string",
        • "directDebitBankAccount": "string",
        • "directDebitSwift": "string",
        • "accountProfileNumber": 1,
        • "numberOfInstallments": 1,
        • "installmentAmount": 1.00,
        • "contractDate": "string",
        • "orderDate": "string",
        • "installmentProfileNumber": 1,
        • "parentTransactionReference": "string",
        • "transactionReference": "string",
        • "dueDate": "string",
        • "invoiceDate": "string",
        • "yourReference": "string",
        • "ourReference": "string",
        • "invoiceProfileNumber": 1,
        • "ocr": "string",
        • "installmentCustomerInterestRate": 1.00,
        • "imageUrl": "string",
        • "captureItems": [ ...
          • {
            • "productId": "string",
            • "groupId": "string",
            • "description": "string",
            • "type": "string",
            • "netUnitPrice": 1.00,
            • "grossUnitPrice": 1.00,
            • "quantity": 1.00,
            • "unitCode": "string",
            • "vatCategory": "string",
            • "vatPercent": 1.00,
            • "vatAmount": 1.00,
            • "imageUrl": "string",
            • "googleProductCategoryId": 1,
            • "googleProductCategory": "string",
            • "merchantProductType": "string",
            • "lineNumber": 1,
            • "productUrl": "string",
            • "marketPlaceSellerId": "string",
            • "parentTransactionReference": "string",
            • "additionalInformation": "string"
            }
          ],
        • "shippingDetails": [ ...
          • {
            • "shippingNumber": 1,
            • "type": "string",
            • "shippingCompany": "string",
            • "trackingId": "string",
            • "trackingUrl": "string"
            }
          ]
        }
      ],
    • "refunds": [ ...
      • {
        • "reservationId": "string",
        • "customerNumber": "string",
        • "refundNumber": "string",
        • "orderNumber": "string",
        • "amount": 1.00,
        • "balance": 1.00,
        • "currency": "string",
        • "insertedAt": "string",
        • "updatedAt": "string",
        • "captureNumber": "string",
        • "refundItems": [ ...
          • {
            • "productId": "string",
            • "groupId": "string",
            • "description": "string",
            • "type": "string",
            • "netUnitPrice": 1.00,
            • "grossUnitPrice": 1.00,
            • "quantity": 1.00,
            • "vatPercent": 1.00,
            • "vatAmount": 1.00,
            • "imageUrl": "string",
            • "googleProductCategoryId": 1,
            • "googleProductCategory": "string",
            • "merchantProductType": "string",
            • "productUrl": "string",
            • "marketPlaceSellerId": "string",
            • "additionalInformation": "string"
            }
          ],
        • "parentTransactionReference": "string",
        • "transactionReference": "string"
        }
      ],
    • "cancellations": [ ...
      • {
        • "cancellationNo": "string",
        • "cancellationAmount": 1.00,
        • "cancellationItems": [ ...
          • {
            • "cancellationNumber": "string",
            • "productId": "string",
            • "groupId": "string",
            • "description": "string",
            • "type": "string",
            • "netUnitPrice": 1.00,
            • "grossUnitPrice": 1.00,
            • "quantity": 1.00,
            • "unitCode": "string",
            • "vatCategory": "string",
            • "vatPercent": 1.00,
            • "vatAmount": 1.00,
            • "imageUrl": "string",
            • "googleProductCategoryId": 1,
            • "googleProductCategory": "string",
            • "merchantProductType": "string",
            • "lineNumber": 1,
            • "productUrl": "string",
            • "marketPlaceSellerId": "string",
            • "parentTransactionReference": "string",
            • "additionalInformation": "string"
            }
          ],
        • "parentTransactionReference": "string"
        }
      ],
    • "payment": { ...
      • "type": "string",
      • "contractId": "string",
      • "directDebit": { ...
        • "bankCode": "string",
        • "bankAccount": "string",
        • "token": "string"
        },
      • "campaign": { ...
        • "campaignNumber": 1
        },
      • "invoice": X,
      • "account": { ...
        • "profileNo": 1
        },
      • "consolidatedInvoice": { ...
        • "invoiceDate": "string"
        },
      • "installment": { ...
        • "profileNo": 1,
        • "numberOfInstallments": 1,
        • "customerInterestRate": 1.00
        }
      }
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]