heroImage

Captured payments

Captured payments

PATH:

/api/v3/orders/{orderNumber}/captures/{captureNumber}

PATH PARAMETERS:

orderNumber
required

string

Order number

captureNumber
required

string

Capture number

RESPONSES:

200 OK

RESPONSE SCHEMA:

captures

array of captures

Collection of captures

Array () [
reservationId

string Format: uuid

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:EURNOKSEKDKKCHF

Currency code.

insertedAt

string Format: date-time

Indicates the capture creation time.

updatedAt

string Format: date-time

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 Format: date-time

Contract date.

orderDate

string Format: date-time

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 Format: date-time

Due date.

invoiceDate

string Format: date-time

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.

productUser

string <= 50 characters

Product User.

costCenter

string <= 50 characters

Used for B2B to specify the costCenter e.g. Marketing or Sales Department - Displayed on the invoice.

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:PhysicalArticleDigitalArticleGiftCardDiscountShippingFeeSurchargeInfo

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:HighCategoryLowCategoryNullCategoryNoCategoryMiddleCategoryOtherCategory

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.

specification

object

Specification.

serviceStart

string Format: date-time

Capture start time.

serviceEnd

string Format: date-time

Capture end time.

]
shippingDetails

array of shippingDetails

Shipping details.

Array () [
shippingNumber
required

integer

Unique shipping number within one capture

type
required

string

Enum:ShipmentReturn

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

]
]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

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:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

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}/captures/{captureNumber}

Response samples

200400
  • {
    • "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",
        • "productUser": "string",
        • "costCenter": "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",
            • "specification": X,
            • "serviceStart": "string",
            • "serviceEnd": "string"
            }
          ],
        • "shippingDetails":[...
          • {
            • "shippingNumber": 1,
            • "type": "string",
            • "shippingCompany": "string",
            • "trackingId": "string",
            • "trackingUrl": "string"
            }
          ]
        }
      ]
    }
  • {
    • "type": "string",
    • "code": "string",
    • "message": "string",
    • "customerFacingMessage": "string",
    • "actionCode": "string",
    • "fieldReference": "string"
    }