For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Guides API Reference

Reference

Introduction
Request Headers
Authentication
Errors
Data Requirements
Create Checkout
Get Checkout
Checkout-Request
Checkout-Response
Get Configuration
Get Configuration Mappings
Merchant limits
Cash App Pay Configuration
Retrieve Dispute
Receive Dispute
Respond to Dispute
Accept Dispute
Upload File
Retrieve file
dispute
meta
evidence
Create Grant Approval
Create Grant
Retrieve Grant
Revoke Grant
Create Grant Alias
Start Grant Link Flow
Grant status updated
Retrieve Grant
Revoke Grant
RetrieveGrantRequest
Grant
Event: grant.status.updated
Create Order
List Payments
Auth
Capture Full Payment
Get Payment By Order ID
Update Payment by Order ID
Capture Payment
Update Shipping Courier
Create Refund
Void
Get Payment By Token
Reverse Payment By Token
AuthorizePayment
CapturePayment
Ping
Contact Object
Consumer Object
Discount Object
Item Object
Money Object
Order Details Object
Payment Object
Payment Event Object
Refund Object
Shipping Courier Object

Reference Payments Schemas

CapturePayment

Example

1 {
2   "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
3   "merchantReference": "merchant-order-123",
4   "amount": {
5     "amount": "100.00",
6     "currency": "AUD"
7   },
8   "paymentEventMerchantReference": "payment-ref-123"
9 }

Response

capture_paymentobjectRequired

Was this page helpful?