--- title: "Order:Retry" method: PATCH path: "/v1/orders/{id}/retry" tags: ["Order"] --- # Order:Retry `PATCH /v1/orders/{id}/retry` Retry an order that has a failed endstate by resetting the order status. Please note that the Order type will be changed to PAYLINK and the pointOfInteraction to ECOMMERCE. Also, any existing payments will not be removed. ## Path parameters - `id` string, required ## Request body - OrderOrderRetryInputDtoGenericApi - `expire` string, date-time, required — The time at which this order expires. Must be in ATOM (ISO-8601) notation. ## Response `200` Order retry success - OrderOutput - `id` string — The unique identifier of your order. - `type` string — The order type. - `serviceId` string — The Service ID used for creating this order - `description` string, nullable — The description given for this order. - `reference` string, nullable — The reference given for this order. - `manualTransferCode` string — The manual transfer code that can be used to transfer the order amount to PAY. using a bank transfer. - `orderId` string — The order ID as you would see it within the PAY. platform. - `uuid` string — The UUID that can be used to create a QR code for this order. - `customerKey` string, nullable — An identifier for the customer - `status` OrderOutputStatus - `code` integer — The numeric status code. - `name` string — The human readable status string. - `action` string — The human readable status group string. - `receipt` string, nullable — Base64 encoded string of the receipt for this order when it's paid. - `integration` OrderOutputIntegration - `pointOfInteraction` string, nullable - `test` boolean — Whether this order was created in Test Mode, defaults to false. - `splitPayments` OrderOutputSplitPayment[] - `serviceId` string - `amount` OrderOutputAmount - `value` integer - `currency` string - `fee` 'receiver' | 'sender' - `stats` OrderOutputStats - `extra1` string, nullable — The first free value which can be tracked in the stats. - `extra2` string, nullable — The second free value which can be tracked in the stats. - `extra3` string, nullable — The third free value which can be tracked in the stats. - `tool` string, nullable — The used tool code which can be tracked in the stats. - `info` string, nullable — The used info code which can be tracked in the stats. - `object` string, nullable — The object which can be tracked in stats. - `promotorId` integer, nullable - `domainId` string, nullable - `transferData` object — Contains the transferData values given when the order was created. - `amount` OrderOutputAmount - `value` integer - `currency` string - `authorizedAmount` OrderOutputAmount - `value` integer - `currency` string - `capturedAmount` OrderOutputAmount - `value` integer - `currency` string - `checkoutData` OrderOutputCheckoutData - `customer` OrderOutputCheckoutDataCustomer - `email` string, nullable - `firstName` string, nullable - `lastName` string, nullable - `dateOfBirth` string, date-time, nullable - `gender` string, nullable - `phone` string, nullable - `locale` string, nullable - `ipAddress` string, nullable - `reference` string, nullable - `company` OrderOutputCheckoutDataCompany - `name` string, nullable - `cocNumber` string, nullable - `vatNumber` string, nullable - `country` string, nullable - `billingAddress` OrderOutputCheckoutDataAddress - `firstName` string, nullable - `lastName` string, nullable - `streetName` string, nullable - `streetNumber` string, nullable - `streetNumberAddition` string, nullable - `zipCode` string, nullable - `city` string, nullable - `countryCode` string, nullable - `regionCode` string, nullable - `shippingAddress` OrderOutputCheckoutDataAddress - `firstName` string, nullable - `lastName` string, nullable - `streetName` string, nullable - `streetNumber` string, nullable - `streetNumberAddition` string, nullable - `zipCode` string, nullable - `city` string, nullable - `countryCode` string, nullable - `regionCode` string, nullable - `payments` OrderOutputPayment[] — The payments that are linked to this order. - `id` string — The unique ID of this payment - `paymentMethod` PaymentMethodOutputDtoGenericApi - `id` integer, nullable - `input` string[] - `billingLineId` integer, nullable — The capture payment profile id. - `customerType` string, nullable - `customerKey` string, nullable — A hashed string identifying the customer itself without exposing sensitive data. - `customerId` string, nullable — The identifier of the customer as known by the payment method. For example the IBAN. - `customerName` string, nullable — The name of the customer as known by the payment method. - `customerMethod` OrderPaymentPayerMethod - `type` string - `data` union - object - `iban` string - `name` string - `bic` string - object - `maskedPan` string - `issuerId` string - `scheme` string - `countryCode` string - `cardType` string - `fundingType` string - `brandCode` string - `brandName` string - `brandProduct` string - `ipAddress` string, nullable — The IP Address of the customer that interacted with this payment. - `secureStatus` boolean — Whether or not the customer was 3DS challenged. - `paymentVerificationMethod` integer, nullable — A numeric id of how this payment was verified. - `status` OrderOutputStatus - `code` integer — The numeric status code. - `name` string — The human readable status string. - `action` string — The human readable status group string. - `currencyAmount` OrderOutputAmount - `value` integer - `currency` string - `amount` OrderOutputAmount - `value` integer - `currency` string - `authorizedAmount` OrderOutputAmount - `value` integer - `currency` string - `capturedAmount` OrderOutputAmount - `value` integer - `currency` string - `supplierData` string[], nullable — Relevant data returned by the supplier. - `recurring` boolean — Whether or not recurring is enabled for this payment - `createdAt` string, date-time — The date-time at which this order was created in our system. - `createdBy` string, nullable — The API token or Service ID that created this order. - `modifiedAt` string, date-time, nullable — The date-time at which this order was modified in our system. This can be done by you or by actions taken within our order-payment flow. - `modifiedBy` string, nullable — The API token or Service ID that did the modification of the order. This can also be the TGU node that was handling the order-payment flow. - `expiresAt` string, date-time — The date-time at which this order expires. - `completedAt` string, date-time, nullable — The date-time at which this order was completed. This means that all underlying payments are captured and money is guaranteed. - `links` object — The links that can be used to interact with this order. ## Other responses - `400` — Invalid input - `403` — Forbidden - `404` — Resource not found - `422` — Unprocessable entity --- [API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)