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 refunds
      • POSTCreate refund
      • GETRetrieve refund
      • POSTCapture refund
      • POSTVoid refund
      • POSTVoid refund by idempotency key
      • Refund
      • POSTEvent: refund.status.updated
  • Customer Request API
  • Management API
LogoLogo
Network APIRefunds

Refund

Example
1{
2  "id": "PWCR_da1v3j4p3z15y47adpzzq0whj",
3  "amount": 2500,
4  "currency": "USD",
5  "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
6  "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
7  "status": "AUTHORIZED",
8  "created_at": "2022-01-01T12:00:00Z",
9  "updated_at": "2022-01-05T12:00:00Z",
10  "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
11  "payment_id": "PWC_4nn21zy6t0v2yhqg5bvhk7xkq",
12  "reference_id": "external-id",
13  "metadata": {},
14  "decline_errors": [
15    {
16      "category": "INVALID_REQUEST_ERROR",
17      "code": "MISSING_REQUIRED_FIELD",
18      "detail": "Missing required parameter.",
19      "field": "field_a[2].field_b"
20    }
21  ]
22}
Was this page helpful?
Previous

Event: refund.status.updated

Next
Built with

Response

refundobjectRequired