Retrieve a payment
Returns the authenticated merchant's payment with status, amount totals, payment-method details, and transaction and refund history. Payments owned by another merchant are not returned.
Authorization
basic Basic HTTP authentication
In: header
Path Parameters
Payment id
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/payments/string"{ "id": "01928e1c-2a4d-7c8e-8b1a-1234567890ab", "object": "payment", "status": "CAPTURED", "currency": "usd", "amount": 2999, "paymentMethodType": "CARD", "paymentMethodDetails": { "brand": "visa", "bin": "411111", "last4": "1111", "expirationMonth": 12, "expirationYear": 2027 }, "transactions": [ { "id": "01928e1c-2a4d-7c8e-8b1a-1234567890ab", "object": "transaction", "type": "AUTH_AND_CAPTURE", "status": "SUCCEEDED", "amount": 2999, "parentTransactionId": "01928e1c-2a4d-7c8e-8b1a-1234567890ab", "declinedReason": "Card declined", "reason": "customer request", "refundKind": "PARTIAL", "createdAt": "2026-06-23T12:00:00.000Z", "updatedAt": "2026-06-23T12:00:01.000Z" } ], "amounts": { "requested": 2999, "authorized": 2999, "captured": 2999, "voided": null, "refunded": 1000 }, "createdAt": "2026-06-23T12:00:00.000Z", "authorizedAt": "2026-06-23T12:00:00.000Z", "capturedAt": "2026-06-23T12:00:01.000Z", "voidedAt": null, "updatedAt": "2026-06-23T12:00:01.000Z", "nextAction": { "kind": "REDIRECT", "url": "https://pay.gateway.example/3ds/redirect/…", "method": "GET", "data": { "property1": "string", "property2": "string" }, "fallbackUrl": "string" }}{ "statusCode": 400, "message": "Some fields are invalid, please check the errors", "fieldErrors": { "amount": [ "amount must not be less than 1", "amount must be an integer number" ], "cardNumber": [ "cardNumber must be 12-19 digits with no spaces or separators" ] }}{ "statusCode": 401, "error": "Unauthorized", "message": "Invalid credentials"}{ "statusCode": 404, "error": "Not Found", "message": "Payment not found: 01928e1c-2a4d-7c8e-8b1a-1234567890ab"}Create a hosted checkout link POST
Creates a checkout for the supplied cart and returns the link to the page HighWire hosts for it. The total is computed here: the line items plus shipping and tax, minus the discount. Whoever holds the link can pay, on any device, until expiresAt, so hand it only to the shopper. It is returned once: a replay under the same Idempotency-Key answers without checkoutUrl, and POST /payments/{paymentId}/checkout-session/link issues a new one. Creating the link takes no money and checks none of your limits; the amount counts against them once the payment is captured. The payment settles asynchronously (poll GET /payments/{paymentId}). Answers 400 with code HW_UNSUPPORTED when hosted checkout is not enabled for the account.
Refund a captured payment POST
Refunds a successfully captured payment. Provide an amount for a partial refund, or omit it to refund the entire remaining refundable balance; cumulative refunds cannot exceed the captured amount.