Capture
Capture derives from the parent (original) Authorization transaction – – pass parent transaction identifier (originalTransaction object) with the request.
Deposit Transaction Types
- Capture
- Charge
Capture is initiated by the Merchant and is based on a successful Authorization transaction. Pass authorization identifier with the request.
Charge is a direct funds transfer without a prior Authorization transaction. The Authorization and the actual funds transfer are performed in a single transaction.
In a Deposit transaction, funds are transferred from the buyer’s bank account to the seller’s bank account after the order/service is completely fulfilled.
A Partial Deposit occurs when only part of the amount is transferred.
A Partial Deposit is always followed by a Partial Void Cancel Authorization, because the funds that have not been deposited are to be released back to the buyer.
A Partial Deposit takes place when the order/service has not been completely fulfilled, and some of the transaction amount must be released back to the buyer.
Request Parameters for Capture and Partial Capture transaction types
| Name | Type | Optionality | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. Must be greater than 0. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Value ≥ 0 (2 decimal places) Amount=0 can be passed with Partial Capture transaction Type. | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | optional | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| creditCard | object | conditional | Credit Card data object. Required in case Payment Method is Credit Card. | |||||||||||||||||||||
| ach | object | conditional | ACH data object. Required if Payment method = ACH. | |||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId. Available Values:
| |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | paymentMethod enum values. Available Values:
| |||||||||||||||||||||
| processorData | object | optional | Processor Data data object. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. value ≥ 0 | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. MaxLength(20) | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodId. Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId. Available Values:
| |||||||||||||||||||||
| originalTransaction | object | ✓ | Original Transaction data object. Required for Capture and Refund and Update and Void. |
//Capture request example
{
"accountId": "Platform Account Id",
"amount": 13,
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"billingOverride": [
{
"fixedAmount": "feeFixedAmount",
"id": "objectId",
"percentageAmount": "feePercentageAmount",
"sourceId": "feeSourceIdentifier",
"sourceType": "BillingAccountId",
"targetId": "feeTargetIdentifier",
"targetType": "BillingAccountId",
"reverse": "true",
"billingAmount": "billingAmountValue"
}
],
"creditCard": {
"number": "4111111111111111",
"expirationDate": "1225",
"nameOnCard": "Eleanor Johansson",
"type": "Visa",
"cvv": "123"
},
"currency": "USD",
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"entryMode": "2",
"paymentMethod": "CreditCard",
"processorData": {
"dynamicDescriptor": "01919Z"
},
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Capture",
"originalTransaction": {
"transactionId": "TransactionID",
"transactionType": "System"
}
}