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.
GuidesAPI Reference
GuidesAPI Reference
  • Network API
      • GETList payments
      • POSTCreate payment
      • GETRetrieve payment
      • POSTCreate incremental authorization
      • POSTCapture payment
      • POSTVoid payment
      • POSTVoid payment by idempotency key
      • Payment
      • Enrichments
      • POSTEvent: payment.status.updated
  • Customer Request API
  • Management API
LogoLogo
Network APIPayments

Payment

Example
1{
2  "id": "PWC_4nn21zy6t0v2yhqg5bvhk7xkq",
3  "amount": 1500,
4  "net_amount": 1000,
5  "captured_amount": 1000,
6  "voided_amount": 0,
7  "refunded_amount": 100,
8  "currency": "USD",
9  "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
10  "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
11  "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
12  "status": "AUTHORIZED",
13  "created_at": "2022-01-01T12:00:00Z",
14  "updated_at": "2022-01-05T12:00:00Z",
15  "refund_ids": [
16    "PWCR_da1v3j4p3z15y47adpzzq0whj"
17  ],
18  "reference_id": "external-id",
19  "metadata": {},
20  "enrichments": {
21    "recurring_series_id": "string"
22  },
23  "decline_errors": [
24    {
25      "category": "INVALID_REQUEST_ERROR",
26      "code": "MISSING_REQUIRED_FIELD",
27      "detail": "Missing required parameter.",
28      "field": "field_a[2].field_b"
29    }
30  ]
31}
Was this page helpful?
Previous

Enrichments

Next
Built with

Response

paymentobjectOptional