Home > API > Order Management > Void authorization

Void authorization

Void (cancel) an authorization that has not been captured.

PATH:

/api/v3/orders/{orderNumber}/voids

PATH PARAMETERS:

orderNumber
required

string

Order number

REQUEST BODY SCHEMA:

cancellationDetails
required

cancellationDetails object

Information that is used when the order needs to be canceled. Required for Partial Void

totalNetAmount
required

number

Total net amount of order.

totalGrossAmount
required

number

Total gross amount of order. Must match the grossUnitPrice * quantity of order items

currency

string

Enum: EUR NOK SEK DKK CHF

Order currency. If not set it will be taken from client's source system currency setting

merchantImageUrl

string <= 2048 characters

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

items

array of items

Array of order items. Maximum allowed 200 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.

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.

merchantId

string <= 50 characters

Merchant ID within the AfterPay system, part of the credentials used for AfterPay Netherlands and Belgium. If you were not provided these credentials by your Integration Manager, leave empty.

RESPONSES:

200 OK

RESPONSE SCHEMA:

totalCapturedAmount

number

Total captured amount.

totalAuthorizedAmount

number

Total authorized amount.

remainingAuthorizedAmount

number

If Total Captured and Total Authorized amount differ, the remaining sum must also be captured or voided.

voidedAmount

number

Voided amount.

totalRefundedAmount

number

Total refunded amount

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

post

/api/v3/orders/{orderNumber}/voids

Request samples

  • {
    • "cancellationDetails": { ...
      • "totalNetAmount": 1.00,
      • "totalGrossAmount": 1.00,
      • "currency": "string",
      • "merchantImageUrl": "string",
      • "items": [ ...
        • {
          • "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",
          • "productUrl": "string",
          • "marketPlaceSellerId": "string",
          • "additionalInformation": "string"
          }
        ]
      },
    • "parentTransactionReference": "string",
    • "merchantId": "string"
  • }

Response samples

200400
  • {
    • "totalCapturedAmount": 1.00,
    • "totalAuthorizedAmount": 1.00,
    • "remainingAuthorizedAmount": 1.00,
    • "voidedAmount": 1.00,
    • "totalRefundedAmount": 1.00
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]