Looking Up Payment Requests

Use this guide to better understand how you can look up a previously created Payment Request

Overview

You may want to look up a Payment Request for a number of reasons. You may wish to get the details so you can then modify it, or you may simply want to confirm its status.

📘

Reminder: Delivery Options

This documentation describes an integration with PayLink that does not include delivery of the link to your end user. With this integration, you will be responsible for link delivery by whatever methods you currently utilize.

If you would like to take advantage of PayLink with text and email delivery, please reach out to your sales representative.

API Request

👍

This endpoint uses HMAC

Please read our API Authentication section to ensure you are crafting your request properly.

This endpoint references the paymentRequestId of the Payment Request, which was originally provided in the response body when you created the Payment Request. To look up a Payment Request, send an API call to:

GET {{baseURL}}/payment-requests/{{paymentRequestId}}

Request Body Parameters There is no request body for this request.

API Response

Response Body Parameters The response body will include all of the elements that you passed to us when you created the Payment Request. It will also include the following additional fields:
NameTypeDescription
statusenum (Open, PaidOffPlatform, CancelledByMerchant, PaidOnPlatform, Expired)Denotes what status the payment request is in.

Open is a request that has been created and has not been paid, invalidated or expired. It is possible that the status could be Open if the consumer attempted to pay the request but received an error. For more information see the orderId parameter

PaidOffPlatform is a request that you have told us (via API call) was paid on a non-Skipify platform

CancelledByMerchant is a request that you have told us (via API call) to invalidate

PaidOnPlatform is a Payment Request that has been successfully paid using Skipify PayLink

Expired is a Payment Request that has passed the datetime specified by you in the expiration field of the original Payment Request
orderIdstring, nullableID of the associated order. This is null until after the customer submits payment.

If the orderId is populated and the status of the Payment Request is PaidOnPlatform, then the payment was successful

If the orderId is populated and the status of the Payment Request is Open then the payment was unsuccessful. For more information please review the GET Order endpoint
paymentTimeStampdatetimeThis is a field we use to track when the actual payment went in.

Only populated if the Payment Request was paid using Skipify (PaidOnPlatform).
hashstringThis is an internal field we use to track the order.
Response Body Example 
{
    "paymentRequestId": "578b1e70-7cbd-431e-a675-51a2ea46d5cd",
    "merchantPaymentRequestId": "d8a9aa70-08f3",
    "status": "Open",
    "total": 27487,
    "subtotal": 23700,
    "tax": 1287,
    "shipping": 2500,
    "currencyCode": "USD",
    "metadata": {
        "internal_id": "aa1122"
    },
    "expiration": "2022-06-02T21:48:02Z",
    "lineItems": [
        {
            "sku": "Large Cheese Pizza",
            "description": "Some believe that pizza is a vegetable",
            "amount": 1500,
            "category": "Order 1: Kyle's 3rd Birthday Party",
            "externalId": "5e5fa0c2-a40e-463a-8f3f-c46bc30ce2fc"
        },
        {
            "sku": "Birthday Cake",
            "description": "Chocolately goodness",
            "amount": 2200,
            "category": "Order 1: Kyle's 3rd Birthday Party",
            "externalId": "76ac2a74-3765-4957-8ccd-bd6e91266e8d"
        },
        {
            "sku": "Plates and Napkins",
            "description": "Free of charge",
            "amount": null,
            "category": "Order 1: Kyle's 3rd Birthday Party",
            "externalId": "71dd7bbb-3504-43d4-b429-516862265945"
        },
        {
            "sku": "Case of Craft Beer",
            "description": "Tasty",
            "amount": 3000,
            "category": "Order 2: Parent's Afterparty",
            "externalId": "836b9e24-6a10-403e-b21a-a907fe475ab7"
        },
        {
            "sku": "Case of Hard Seltzer",
            "description": null,
            "amount": 1500,
            "category": "Order 2: Parent's Afterparty",
            "externalId": "bb3aa832-563b-49f0-98c3-9487e9d88e51"
        },
        {
            "sku": "Fee for the Party Clown",
            "description": null,
            "amount": 15500,
            "category": null,
            "externalId": "7698f00d-082b-43b8-b433-3d73c5849c24"
        }
    ],
    "orderId": null,
    "paymentTimestamp": null,
    "hash": "b02bd654d0c6b0b7defcf7b843baede9526ea5535d2e490ffdcbca79634f25fa"
}

👍

API Reference

Our API Reference contains additional details about this endpoint and its use.


Updated 5 months ago