Guides
Back to skipify.comContact Us

GET Order

Learn how this endpoint allows you to look up Orders submitted by Skipify

Suggest Edits

Overview

Use the Get Order endpoint to find up-to-date information. like current status, about a previously created Order with Skipify.

🚧

Important!

This call can only look up an order. To modify an order, call the Capture, Void, or Refund endpoints.

To specify which order to lookup, this endpoint utilizes Order IDs which can be obtained in a number of different ways depending on your preference and/or payment pipeline.

API Request

👍

This endpoint uses MAC with SHA-256

Check out our API Authentication learn more

This endpoint uses Order IDs to access orders. Order IDs can be obtained during different parts of the order flow depending on the Skipify payment pipeline being used:

Connected Checkout & the Skipify Button

When creating orders using Connected Checkout or the Skipify Button, Skipify's orderID is provided as part of the SDK Success Callback. Alternatively, the order can be queried using the orderId specified when first creating the order

📘

Note

This orderId is saved as the merchantOrderId in Skipify's systems

PayLink

The initial request via PayLink is called a Payment Request (as opposed to an Order). Payment Requests will only have an orderId after a customer has visited the Payment Request URL and attempted to pay. To determine if your Payment Request has an orderId, look up the Payment Request.

  • If the Payment Request has an Open status, it means the attempted payment was unsuccessful and the corresponding Order will have an ERROR status.
  • If the Payment Request has a PaidOnPlatform status, it means the attempted payment was successful and the corresponding Order will have a PROCESSED status.

To access get an Order, send an API call to:

GET {{baseURL}}/orders/{{orderId}}

📘

Note

This request does not require a request body

API Response

Response Body Fields

FieldTypeDescription
externalIdStringThis order's unique Skipify identifier
totalNumberThe total price for this order, listed in cents
subtotalNumberThe subtotal for items in this order, listed in cents
taxNumberThe tax for this order, listed in cents
shippingNumberThe shipping cost for this order, listed in cents
tipNumberThe tip paid for this order, listen in cents
orderDescriptionStringThe order description for this order set when creating details in the Order Details callback
metadataObjectMetadata for this order set when creating a payment request
statusStringThe current status of the payment:
- PENDING - when an order is created
- PROCESSED - when an authorization or sale is performed
- ERROR - when a transaction is not successful
- CANCELLED - when an order is authorized, then fully voided
settlementTypeStringThe settlement type of this order. This configuration can be set in the Merchant Portal.
lastProcessingAttemptStringTimestamp of the last time an attempt was made to make a payment on the order. Includes attempted payments that were successful, were declined, and had invalid credit card numbers/expiration dates.
currencyCodeStringThe code for the currency used in this order. ex: USD
hashStringUsed by Skipify for verification purposes. Integrating merchants can ignore this field.
merchantOrderIdStringThe merchant's Order ID passed to Skipify during the Order Details callback
merchantIdStringThis merchant's unique Skipify identifier
merchantNameStringThis merchant's name
customerIdStringThe customer's unique Skipify identifier
addressIdStringThe unique Skipify identifier for the customer's address
paymentIdStringThis payment's unique Skipify identifier
paymentMethodObjectDetails of the payment credit card used for this order
billingAddressIdStringThe unique Skipify identifier for the customer's billing address
billingAddressObjectDetails of the billing address used for this order
shippingAddressIdStringThe unique Skipify identifier for the customer's shipping address
shippingAddressObjectDetails of the shipping address used for this order
shippingMethodIdStringThe unique Skipify identifier for the shipping option selected
shippingMethodObjectDetails of the shipping method used for this order
tipPercentagesArrayAn array of pre-selected tip percentages available for customers to select. Tipping can be toggled on/off in the Merchant Portal.
transactionsArrayAn array of payment gateway transactions associated with this order that have been processed through Skipify's SDK/API.
- The different transaction types can be viewed in Skipify's API Reference page.
- The gatewayTransactionId can be referenced to communicate directly with your gateway about this transaction.

Note: Transactions that are processed directly with your payment gateway will not be displayed in this field.
orderLineItemsArrayAn array of line items in this order
purchaseDetailsArrayAn array of details included in the header of the Skipify wallet. See Purchase Details for more details.

Response Body Example

{
  "externalId": "string",
  "total": 0,
  "subtotal": 0,
  "tax": 0,
  "shipping": 0,
  "tip": 0,
  "orderDescription": "string",
  "metadata": {
    "string": "string",
    "string": "string"
  },
  "status": "PENDING", // statuses include PENDING, ERROR, and PROCESSED
  "settlementType": "Sale",
  "lastProcessingAttempt": "2021-10-11T17:16:23.251Z",
  "currencyCode": "string",
  "hash": "string",
  "merchantOrderId": "string",
  "merchantId": "string",
  "merchantName": "string",
  "customerId": "string",
  "addressId": "string",
  "paymentId": "string",
  "paymentMethod": {
    "cardBrand": "string", // Possible values include “Visa”, “Mastercard”, “Amex”, “DinersClub”, “Discover”, “UnionPay” and “JCB”
    "expMonth": 1,
    "expYear": 2030,
    "last4CardNumber": 1111,
    "cardLinked": false
  },
  "billingAddressId": "string",
  "billingAddress": {
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zip": "string",
    "phoneNumber": "string",
    "cardLinked": false
  },
  "shippingAddressId": "string",
  "shippingAddress": {
    "firstName": "string",
    "lastName": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zip": "string",
    "phoneNumber": "string",
    "cardLinked": false
  },
  "shippingMethodId": "string",
  "shippingMethod": {
    "externalId": "string",
    "name": "string",
    "price": 0,
    "tax": 0
  },
  "tipPercentages": [
    {
      "percent": 0,
      "amount": 0
    }
  ],
  "transactions": [
    {
      "gatewayTransactionId": "string",
      "amount": 0,
      "type": "SALE",
      "status": "SUCCESS",
      "orderId": "string",
      "externalId": "string"
    }
  ],
  "orderLineItems": [
    {
      "sku": "string",
      "description": "string",
      "amount": 0,
      "category": "string",
      "externalId": "string"
    }
  ]
}

👍

API Reference

Check out our API Reference to learn more


Skipify baner with link to contact us form

Updated about 1 year ago