Charge
Request Parameters
Transaction Packet
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Amount=0 can be passed with Charge transaction type. | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | optional | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| creditcard | object | ✓ | Credit Card data object. | |||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId. Available Values:
| |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | paymentMethodTypeId. Available Values:
| |||||||||||||||||||||
| processorData | object | ✓ | Processor Data data object. | |||||||||||||||||||||
| paymentType | enum | optional | PaymentType enum values. Available Values:
| |||||||||||||||||||||
| status | enum | ✓ | transactionStatusId. Available Values:
| |||||||||||||||||||||
| subaccountid | integer | ✓ | Sub-Account identifier. | |||||||||||||||||||||
| terminalid | string | optional | Terminal identifier. | |||||||||||||||||||||
| transactionmethod | optional | transactionMethodId Available Values:
| ||||||||||||||||||||||
| type | enum | ✓ | transactionTypeId Available Values:
|
{
"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": {
"bin": "411111",
"expirationDate": "1220",
"last4": "1111",
"nameOnCard": "Eleanor Johnson",
"type": "Visa"
},
"currency": "USD",
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"entryMode": "2",
"paymentMethod": "CreditCard",
"paymentType": "OneOff",
"processorData": {
"authorizationNumber": "01919Z",
"errorCode": "",
"errorCodeDescription": "",
"transactionId": "1234567891"
},
"status": "Processed",
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Charge"
}