Payout Transactions
Transaction requirements
Request Parameters
| Name | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| subAccountId | integer | ✓ | Sub-Account identifier. Must be greater than 0. | ||||||
| accountId | integer | ✓ | Platform Account identifier. Must be greater than 0. | ||||||
| amount | decimal | ✓ | Transaction amount. value ≥ 0 (2 decimal places) | ||||||
| currency | enum | ✓ | CurrencyTypeId. Valid Parameters
| ||||||
| type | enum | ✓ | transactionTypeId. Valid Parameters
| ||||||
| paymentMethod | enum | ✓ | PaymentMethodTypeId. Valid Parameters
| ||||||
| entryMode | integer | Nullable Transaction entry mode numerical value. | |||||||
| billingAddress | object | User Billing Address data object. | |||||||
| creditCard | object | conditional | Credit Card data object. Required if payment method = CreditCard; | ||||||
| ach | object | conditional | ACH data object. Required if Payment method = ACH. | ||||||
| originalTransaction | object | ✓ | Original Transaction data object. Required for for Submit transaction. | ||||||
| merchantData | object | Merchant Data data object. |
Request example
{
"accountId": "Platform Account Id",
"subAccountId": "Sub-Account Id",
"amount": 100,
"currency": "USD",
"type": "Payout",
"paymentMethod": "CreditCard",
"entryMode": "2",
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"creditCard": {
"number": "4111111111111",
"expirationDate": "1220",
"nameOnCard": "Eleanor Johansson",
"type": "Visa",
"cvv": "123"
},
"ach": {
"accountNumber": "1099999903",
"accountType": "Savings",
"entityType": "Personal",
"nameOnAccount": "Eleanor Johnson",
"routingNumber": "114567895"
},
"originalTransaction": {
"transactionId": "732000000002107745",
"transactionType": "Merchant"
},
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
}
}