CHcheckout
Payment Links

Get Payment Link details

Retrieve details about a specific Payment Link using its ID returned when the link was created. In the response, you will see the status of the Payment Link.<br><br> For more information, see the <a target="_blank" href="https://www.checkout.com/docs/integrate/payment-links">Payment Links documentation</a>.

get/payment-links/{id}

Request

Path parameters

idstring required

The unique identifier for a Payment Link.

Response

Payment Link details retrieved successfully

OR
OR

Example response

{
  "id": "pl_ELqQJXdXzabU",
  "status": "Active",
  "payment_id": "pay_88cb4e671m1da22e9bbbyx",
  "amount": 100,
  "currency": "GBP",
  "reference": "ORD-123A",
  "description": "Payment for Gold Necklace",
  "created_on": "2021-08-19T20:25:28.7250000+00:00",
  "expires_on": "2021-08-20T20:25:28.0000000+08:00",
  "processing_channel_id": "pc_q4dbxom5jbgudnjzjpz7j2z6uq",
  "amount_allocations": [
    {
      "id": "ent_w4jelhppmfiufdnatam37wrfc4",
      "amount": 1000,
      "reference": "ORD-5023-4E89",
      "commission": {
        "amount": 1000,
        "percentage": 1.125
      }
    }
  ],
  "customer": {
    "email": "brucewayne@email.com",
    "name": "Bruce Wayne"
  },
  "shipping": {
    "address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "billing": {
    "address": {
      "address_line1": "123 High St.",
      "address_line2": "Flat 456",
      "city": "London",
      "zip": "SW1A 1AA",
      "country": "GB"
    },
    "phone": {
      "country_code": "+1",
      "number": "415 555 2671"
    }
  },
  "products": [
    {
      "url": "https://example.com/products/gold-necklace",
      "name": "Gold Necklace",
      "quantity": 1,
      "price": 1000
    }
  ],
  "return_url": "https://example.com/success",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.sandbox.checkout.com/payment-links/pl_ELqQJXdXzabU"
    },
    "redirect": {
      "href": "https://pay.sandbox.checkout.com/link/pl_ELqQJXdXzabU"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.