Capture Subscription Request
November 13, 2025 ยท View on GitHub
The charge amount from the subscriber.
Structure
CaptureSubscriptionRequest
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
Note | String | Required | The reason or note for the subscription charge. Constraints: Minimum Length: 1, Maximum Length: 128, Pattern: ^.*$ | String getNote() | setNote(String note) |
CaptureType | CaptureType | Required | The type of capture. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$ | CaptureType getCaptureType() | setCaptureType(CaptureType captureType) |
Amount | Money | Required | The currency and amount for a financial transaction, such as a balance or payment due. | Money getAmount() | setAmount(Money amount) |
Example (as JSON)
{
"note": "note4",
"capture_type": "OUTSTANDING_BALANCE",
"amount": {
"currency_code": "currency_code6",
"value": "value0"
}
}