For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference
    • Introduction
      • Capture Payment
      • Consumer
      • Consumer Offers
      • Contact
      • Create Refund
      • Discount
      • Interval
      • Item
      • Money
      • Offer
      • Offers Request
      • Offers Response
      • Order Details
      • Payment Event
      • Payment
      • Payment (Auth)
      • Payment Schedule
      • Refund
      • Shipping Courier
LogoLogo
ReferenceModels

Payment

Example
1{
2  "id": "300000016189",
3  "token": "002.6bjbsaowxvfqam2nw4u3xudppheuh4gsuat3n2w3f6t44euzgy",
4  "status": "APPROVED",
5  "created": "2024-03-11T20:11:42.487Z",
6  "originalAmount": {
7    "amount": "37.00",
8    "currency": "USD"
9  },
10  "openToCaptureAmount": {
11    "amount": "0.00",
12    "currency": "USD"
13  },
14  "paymentState": "CAPTURED",
15  "merchantReference": "updated-k6-reference-utaddnpx",
16  "refunds": [],
17  "orderDetails": {
18    "consumer": {},
19    "billing": {
20      "name": "Joe Customer",
21      "line1": "1004 New Avenue",
22      "postcode": "94121",
23      "countrycode": "US",
24      "phoneNumber": "2120000000"
25    },
26    "shipping": {
27      "name": "Joe Customer",
28      "line1": "1004 New Avenue",
29      "postcode": "94121",
30      "countrycode": "US",
31      "phoneNumber": "2120000000"
32    },
33    "courier": {
34      "shippedAt": "2024-01-01T08:00:00Z",
35      "name": "FedEx",
36      "tracking": "000 000 000 000",
37      "priority": "STANDARD"
38    },
39    "items": {
40      "name": "Blue Carabiner",
41      "sku": "12341234",
42      "quantity": 1,
43      "price": {
44        "amount": "40.00",
45        "currency": "USD"
46      }
47    },
48    "categories": {
49      "name": "Jeans",
50      "sku": "123412345",
51      "quantity": 1,
52      "price": {
53        "amount": "20.00",
54        "currency": "USD"
55      },
56      "categories": null
57    }
58  },
59  "discounts": [],
60  "shippingAmount": {
61    "amount": "10.00",
62    "currency": "USD"
63  },
64  "taxAmount": {
65    "amount": "0.00",
66    "currency": "USD"
67  },
68  "events": {
69    "id": "2dYbLXpOtEPQbg1DT7x9D8R4oCY",
70    "created": "2024-03-11T20:11:43.897Z",
71    "expires": null,
72    "type": "CAPTURED",
73    "amount": {
74      "amount": "37.00",
75      "currency": "USD"
76    },
77    "paymentEventMerchantReference": "k6-gsrdqspusf"
78  }
79}
Was this page helpful?
Previous

Payment (Auth)

Next
Built with

Response

paymentobjectRequired
Describes the schema for a (read-only) payment object