Save a transaction

ApiScope: payment.transaction.write
API Scope Level: DepartmentScope

application/json

Request Body required

departmentUuid string
paymentAttemptUuid string
deviceType string

Possible values: [MANUAL, SWIPER, IPAD_SWIPER, ONLINE, IPAD_MANUAL, MAGTEK_MANUAL, MAGTEK_SWIPE, MAGTEK_EMV, MIURA_CHIP, REPAIR_FINANCING, GUARANTOR_CHECK, MIURA_SWIPER, MIURA_CONTACTLESS, OPENEDGE_CHIP, OPENEDGE_SWIPER, OPENEDGE_MANUAL, OPENEDGE_MANAUL, OPENEDGE_WALKERBT_CHIP, OPENEDGE_CLOUD_CHIP, OPENEDGE_CLOUD_SWIPE, OPENEDGE_CLOUD_MANUAL, OPENEDGE_WALKERBT_SWIPE, OPENEDGE_CLOUD_ICMP_CHIP, OPENEDGE_CLOUD_ICMP_SWIPE, OPENEDGE_CLOUD_ICMP_MANUAL, OPENEDGE_CLOUD_ICMP_CONTACTLESS, OPENEDGE_CLOUD_CONTACTLESS, OPENEDGE_WALKERBT_CHIP_ANDROID, OPENEDGE_WALKERBT_SWIPE_ANDROID, OPENEDGE_MANUAL_IOS, OPENEDGE_MANUAL_ANDROID, TRIPOS_VERIFONE_CHIP, TRIPOS_VERIFONE_SWIPE, TRIPOS_VERIFONE_MANUAL, TRIPOS_VERIFONE_CONTACTLESS, TRIPOS_IPP320_CHIP, TRIPOS_IPP320_SWIPE, TRIPOS_IPP320_MANUAL, TRIPOS_IPP320_CONTACTLESS, TRIPOS_ISMP_CHIP, TRIPOS_ISMP_SWIPE, TRIPOS_ISMP_MANUAL, TRIPOS_ISMP_CONTACTLESS, CREDITCALL_CHIP, CREDITCALL_SWIPER, CREDITCALL_MANUAL, CREDITCALL_CONTACTLESS, NMI_LANE_CHIP, NMI_LANE_SWIPE, NMI_LANE_MANUAL, NMI_LANE_CONTACTLESS, NMI_VERIFONE_CHIP, NMI_VERIFONE_SWIPE, NMI_VERIFONE_MANUAL, NMI_VERIFONE_CONTACTLESS, NMI_BBPOS_CHIP_ANDROID, NMI_BBPOS_SWIPE_ANDROID, NMI_BBPOS_CHIP_IOS, NMI_BBPOS_SWIPE_IOS, STRIPE_BBPOS_WISEPOS_E_CHIP, STRIPE_BBPOS_WISEPOS_E_SWIPE, STRIPE_BBPOS_WISEPOS_E_CONTACTLESS, CARDCONNECT_ISMP_CHIP, CARDCONNECT_ISMP_SWIPE, CARDCONNECT_ISC250_CHIP, CARDCONNECT_ISC250_SWIPE, CARDCONNET_ISMP_MANUAL, CARDCONNECT_ISC250_MANUAL, CARDCONNECT_ISMP_CONTACTLESS, CARDCONNECT_ISC250_CONTACTLESS, CARDCONNECT_LANE_5000_MANUAL, CARDCONNECT_LANE_5000_CHIP, CARDCONNECT_LANE_5000_SWIPE, CARDCONNECT_LANE_5000_CONTACTLESS, CARDCONNECT_CLOVER_MANUAL, CARDCONNECT_CLOVER_CHIP, CARDCONNECT_CLOVER_SWIPE, CARDCONNECT_CLOVER_CONTACTLESS, STRIPE_APPLE_PAY, STRIPE_GOOGLE_PAY, STRIPE_M2, IPHONE_TAP_TO_PAY]

gatewayResponse object
authorizationCode string
responseCode string
responseReasonCode string
transId string
transRefId string
reasonText string
status string
Possible values: [APPROVED, DECLINED, ERROR]
avsResponse string
cvvResponse string
cardCodeResponse string
attributes object
property name* string
tokens object
property name* string
paymentMethod object

card object

cardNumber string

last4Digits string

cardHolderName string

expiryMonth int32

expiryYear int32

cvv int32

cardBrand string

Possible values: [VISA, MAST, DISC, AMEX, DINER, JCB]

cardType string

Possible values: [Credit, Debit]

warrantyCard boolean

creditCardCIMTokenUuid string

token string

affirm object

checkoutToken string

sunbit object

purchaseId string

applePay object

cardNumber string

last4Digits string

cardHolderName string

expiryMonth int32

expiryYear int32

cvv int32

cardBrand string

Possible values: [VISA, MAST, DISC, AMEX, DINER, JCB]

cardType string

Possible values: [Credit, Debit]

warrantyCard boolean

creditCardCIMTokenUuid string

token string

googlePay object

cardNumber string

last4Digits string

cardHolderName string

expiryMonth int32

expiryYear int32

cvv int32

cardBrand string

Possible values: [VISA, MAST, DISC, AMEX, DINER, JCB]

cardType string

Possible values: [Credit, Debit]

warrantyCard boolean

creditCardCIMTokenUuid string

token string

check object

checkNumber string

checkType string

Possible values: [Business, Personal]

payerName string

idType string

idValue string

methodType string

Possible values: [CARD, CASH, GUARANTEED_CHECK, REGULAR_CHECK, AFFIRM, SUNBIT, APPLE_PAY, GOOGLE_PAY]

transactionSource string

Possible values: [AUTO, MANUAL_RECONCILIATION, AUTO_RECONCILIATION, PAYMENTS_BACKUP]

transactionAttributes object
property name* string

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]
transaction object
status string
Possible values: [APPROVED, DECLINED, ERROR]
id int64
uuid string
paymentGatewayResponse object
id int64
version int64
responseCode int32
responseSubCode string deprecated
responseReasonCode int32
responseReasonText string
detailResponseText string deprecated
authorizationCode string
avsresponse string
description string
amount number
cardCodeResponse string
cardholderAuthenticationVerificationResponse string
accountNumber string deprecated
cardType string
requestedAmount number deprecated
pgtransId string
pgtransRefId string
isApproved boolean
isDeclined boolean
isError boolean
isReview boolean
paymentProviderType string
uuid string
paymentAttemptUuid string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
transactionType string
Possible values: [CHARGE, REFUND, DEPOSIT, VOID, AUTH, CAPTURE, BLOCK]
invoice object
id int64
guid string
invoiceStatus string
amount number
invoiceDate date-time
description string
refundedAmount number
paidDate date-time
fileName string
reminderMileage int64
reminderDate date-time
signatureFileName string
paymentDeclines string
invoiceAttributes object
property name* string
paymentDealer object
dealerUuid string
paymentDealerOrder object
orderNumber string
orderType string
departmentUuid string
dealerOrderUuid string
paymentCustomer object
customerUuid string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
tenderData object
id int64
data string
hash string
tenderSubType object
id int64
subTenderName string
tenderType object
id int64
version int64
tenderName string
availableOnMobile boolean
valid boolean
description string
transDate date-time
transAmount number
source string
paymentProvider string
paymentDealer object
dealerUuid string
name string
paymentDealerOrder object
orderNumber string
orderType string
orderDate date-time
paymentDealer object
dealerUuid string
name string
paymentCustomer object
customerUuid string
firstName string
middleName string
lastName string
company string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
signatureRequestId int64
departmentUuid string
dealerOrderUuid string
numberOfInvoices int32
readyROData string
paidAmount number
amount number
dealerOrderSyncDate date-time
paid boolean
paymentRequestSent boolean
paidOnline boolean
paidInKaarma boolean
suspicious boolean
paymentCustomer object
customerUuid string
firstName string
middleName string
lastName string
company string
deviceType string
Possible values: [MANUAL, SWIPER, IPAD_SWIPER, ONLINE, IPAD_MANUAL, MAGTEK_MANUAL, MAGTEK_SWIPE, MAGTEK_EMV, MIURA_CHIP, REPAIR_FINANCING, GUARANTOR_CHECK, MIURA_SWIPER, MIURA_CONTACTLESS, OPENEDGE_CHIP, OPENEDGE_SWIPER, OPENEDGE_MANUAL, OPENEDGE_MANAUL, OPENEDGE_WALKERBT_CHIP, OPENEDGE_CLOUD_CHIP, OPENEDGE_CLOUD_SWIPE, OPENEDGE_CLOUD_MANUAL, OPENEDGE_WALKERBT_SWIPE, OPENEDGE_CLOUD_ICMP_CHIP, OPENEDGE_CLOUD_ICMP_SWIPE, OPENEDGE_CLOUD_ICMP_MANUAL, OPENEDGE_CLOUD_ICMP_CONTACTLESS, OPENEDGE_CLOUD_CONTACTLESS, OPENEDGE_WALKERBT_CHIP_ANDROID, OPENEDGE_WALKERBT_SWIPE_ANDROID, OPENEDGE_MANUAL_IOS, OPENEDGE_MANUAL_ANDROID, TRIPOS_VERIFONE_CHIP, TRIPOS_VERIFONE_SWIPE, TRIPOS_VERIFONE_MANUAL, TRIPOS_VERIFONE_CONTACTLESS, TRIPOS_IPP320_CHIP, TRIPOS_IPP320_SWIPE, TRIPOS_IPP320_MANUAL, TRIPOS_IPP320_CONTACTLESS, TRIPOS_ISMP_CHIP, TRIPOS_ISMP_SWIPE, TRIPOS_ISMP_MANUAL, TRIPOS_ISMP_CONTACTLESS, CREDITCALL_CHIP, CREDITCALL_SWIPER, CREDITCALL_MANUAL, CREDITCALL_CONTACTLESS, NMI_LANE_CHIP, NMI_LANE_SWIPE, NMI_LANE_MANUAL, NMI_LANE_CONTACTLESS, NMI_VERIFONE_CHIP, NMI_VERIFONE_SWIPE, NMI_VERIFONE_MANUAL, NMI_VERIFONE_CONTACTLESS, NMI_BBPOS_CHIP_ANDROID, NMI_BBPOS_SWIPE_ANDROID, NMI_BBPOS_CHIP_IOS, NMI_BBPOS_SWIPE_IOS, STRIPE_BBPOS_WISEPOS_E_CHIP, STRIPE_BBPOS_WISEPOS_E_SWIPE, STRIPE_BBPOS_WISEPOS_E_CONTACTLESS, CARDCONNECT_ISMP_CHIP, CARDCONNECT_ISMP_SWIPE, CARDCONNECT_ISC250_CHIP, CARDCONNECT_ISC250_SWIPE, CARDCONNET_ISMP_MANUAL, CARDCONNECT_ISC250_MANUAL, CARDCONNECT_ISMP_CONTACTLESS, CARDCONNECT_ISC250_CONTACTLESS, CARDCONNECT_LANE_5000_MANUAL, CARDCONNECT_LANE_5000_CHIP, CARDCONNECT_LANE_5000_SWIPE, CARDCONNECT_LANE_5000_CONTACTLESS, CARDCONNECT_CLOVER_MANUAL, CARDCONNECT_CLOVER_CHIP, CARDCONNECT_CLOVER_SWIPE, CARDCONNECT_CLOVER_CONTACTLESS, STRIPE_APPLE_PAY, STRIPE_GOOGLE_PAY, STRIPE_M2, IPHONE_TAP_TO_PAY]
transactionAttributes object
property name* string
accountBalance number
details string
isSettled boolean
settledDate date-time
paymentGatewayTransId string
isVoided boolean
ipAddress string
parentTransaction object
id int64
transactionType object
id int64
shortCode string
description string
deposit int64
fee int64
description string
transDate date-time
transAmount number
accountBalance number
transRefNum string
details string
category string
source string
isReconciled boolean
isSettled boolean
reconciledDate date-time
settledDate date-time
deviceId int64
paymentGatewayTransId string
isVoided boolean
paymentProvider string
uuid string
transactionDetails object[]
Array [
id int64
transactionId int64
transactionIncompleteId int64
type string
amount number
description string
]
roOwner object
id int64
uuid string
userUuid string
firstName string
lastName string
userName string
cellPhone string
textNumber string
isTextNumberVerified boolean
emailAddress string
nickname string
associateDmsID string
imageUrl string
isValid boolean
bio string
userInviteStatus string
defaultThreadOwnerUserUUID string
outOfOffice boolean
outOfOfficeStartDate string
ssoFeatureEnabled boolean
isDealerMappedToSsoPartner boolean
isSsoPartnerMapped boolean
department object
id int64
name string
uuid string
calendarUuid string
brokerNumber string
communicationGroup string
dealer object
id int64
name string
uuid string
isValid boolean
role object
roleName string
roleAcronym string
cashier object
id int64
uuid string
userUuid string
firstName string
lastName string
userName string
cellPhone string
textNumber string
isTextNumberVerified boolean
emailAddress string
nickname string
associateDmsID string
imageUrl string
isValid boolean
bio string
userInviteStatus string
defaultThreadOwnerUserUUID string
outOfOffice boolean
outOfOfficeStartDate string
ssoFeatureEnabled boolean
isDealerMappedToSsoPartner boolean
isSsoPartnerMapped boolean
department object
id int64
name string
uuid string
calendarUuid string
brokerNumber string
communicationGroup string
dealer object
id int64
name string
uuid string
isValid boolean
role object
roleName string
roleAcronym string
threeDSAuthenticationFailed boolean

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "transaction": {
    "status": "APPROVED",
    "id": 0,
    "uuid": "string",
    "paymentGatewayResponse": {
      "id": 0,
      "version": 0,
      "responseCode": 0,
      "responseReasonCode": 0,
      "responseReasonText": "string",
      "authorizationCode": "string",
      "avsresponse": "string",
      "description": "string",
      "amount": 0,
      "cardCodeResponse": "string",
      "cardholderAuthenticationVerificationResponse": "string",
      "cardType": "string",
      "pgtransId": "string",
      "pgtransRefId": "string",
      "isApproved": true,
      "isDeclined": true,
      "isError": true,
      "isReview": true,
      "paymentProviderType": "string",
      "uuid": "string",
      "paymentAttemptUuid": "string"
    },
    "paymentUser": {
      "id": 0,
      "dealerAssociateUUID": "string",
      "userUUID": "string",
      "dealerDepartmentUUID": "string"
    },
    "transactionType": "CHARGE",
    "invoice": {
      "id": 0,
      "guid": "string",
      "invoiceStatus": "string",
      "amount": 0,
      "invoiceDate": "2025-04-04T18:50:14.009Z",
      "description": "string",
      "refundedAmount": 0,
      "paidDate": "2025-04-04T18:50:14.009Z",
      "fileName": "string",
      "reminderMileage": 0,
      "reminderDate": "2025-04-04T18:50:14.009Z",
      "signatureFileName": "string",
      "paymentDeclines": "string",
      "invoiceAttributes": {},
      "paymentDealer": {
        "dealerUuid": "string"
      },
      "paymentDealerOrder": {
        "orderNumber": "string",
        "orderType": "string",
        "departmentUuid": "string",
        "dealerOrderUuid": "string"
      },
      "paymentCustomer": {
        "customerUuid": "string"
      },
      "paymentUser": {
        "id": 0,
        "dealerAssociateUUID": "string",
        "userUUID": "string",
        "dealerDepartmentUUID": "string"
      }
    },
    "tenderData": {
      "id": 0,
      "data": "string",
      "hash": "string",
      "tenderSubType": {
        "id": 0,
        "subTenderName": "string",
        "tenderType": {
          "id": 0,
          "version": 0,
          "tenderName": "string",
          "availableOnMobile": true
        },
        "valid": true
      }
    },
    "description": "string",
    "transDate": "2025-04-04T18:50:14.009Z",
    "transAmount": 0,
    "source": "string",
    "paymentProvider": "string",
    "paymentDealer": {
      "dealerUuid": "string",
      "name": "string"
    },
    "paymentDealerOrder": {
      "orderNumber": "string",
      "orderType": "string",
      "orderDate": "2025-04-04T18:50:14.009Z",
      "paymentDealer": {
        "dealerUuid": "string",
        "name": "string"
      },
      "paymentCustomer": {
        "customerUuid": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "company": "string"
      },
      "paymentUser": {
        "id": 0,
        "dealerAssociateUUID": "string",
        "userUUID": "string",
        "dealerDepartmentUUID": "string"
      },
      "signatureRequestId": 0,
      "departmentUuid": "string",
      "dealerOrderUuid": "string",
      "numberOfInvoices": 0,
      "readyROData": "string",
      "paidAmount": 0,
      "amount": 0,
      "dealerOrderSyncDate": "2025-04-04T18:50:14.009Z",
      "paid": true,
      "paymentRequestSent": true,
      "paidOnline": true,
      "paidInKaarma": true,
      "suspicious": true
    },
    "paymentCustomer": {
      "customerUuid": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "company": "string"
    },
    "deviceType": "MANUAL",
    "transactionAttributes": {},
    "accountBalance": 0,
    "details": "string",
    "isSettled": true,
    "settledDate": "2025-04-04T18:50:14.009Z",
    "paymentGatewayTransId": "string",
    "isVoided": true,
    "ipAddress": "string",
    "parentTransaction": {
      "id": 0,
      "transactionType": {
        "id": 0,
        "shortCode": "string",
        "description": "string",
        "deposit": 0,
        "fee": 0
      },
      "description": "string",
      "transDate": "2025-04-04T18:50:14.009Z",
      "transAmount": 0,
      "accountBalance": 0,
      "transRefNum": "string",
      "details": "string",
      "category": "string",
      "source": "string",
      "isReconciled": true,
      "isSettled": true,
      "reconciledDate": "2025-04-04T18:50:14.009Z",
      "settledDate": "2025-04-04T18:50:14.009Z",
      "deviceId": 0,
      "paymentGatewayTransId": "string",
      "isVoided": true,
      "paymentProvider": "string",
      "uuid": "string"
    },
    "transactionDetails": [
      {
        "id": 0,
        "transactionId": 0,
        "transactionIncompleteId": 0,
        "type": "string",
        "amount": 0,
        "description": "string"
      }
    ],
    "roOwner": {
      "id": 0,
      "uuid": "string",
      "userUuid": "string",
      "firstName": "string",
      "lastName": "string",
      "userName": "string",
      "cellPhone": "string",
      "textNumber": "string",
      "isTextNumberVerified": true,
      "emailAddress": "string",
      "nickname": "string",
      "associateDmsID": "string",
      "imageUrl": "string",
      "isValid": true,
      "bio": "string",
      "userInviteStatus": "string",
      "defaultThreadOwnerUserUUID": "string",
      "outOfOffice": true,
      "outOfOfficeStartDate": "string",
      "ssoFeatureEnabled": true,
      "isDealerMappedToSsoPartner": true,
      "isSsoPartnerMapped": true,
      "department": {
        "id": 0,
        "name": "string",
        "uuid": "string",
        "calendarUuid": "string",
        "brokerNumber": "string",
        "communicationGroup": "string",
        "dealer": {
          "id": 0,
          "name": "string",
          "uuid": "string",
          "isValid": true
        }
      },
      "role": {
        "roleName": "string",
        "roleAcronym": "string"
      }
    },
    "cashier": {
      "id": 0,
      "uuid": "string",
      "userUuid": "string",
      "firstName": "string",
      "lastName": "string",
      "userName": "string",
      "cellPhone": "string",
      "textNumber": "string",
      "isTextNumberVerified": true,
      "emailAddress": "string",
      "nickname": "string",
      "associateDmsID": "string",
      "imageUrl": "string",
      "isValid": true,
      "bio": "string",
      "userInviteStatus": "string",
      "defaultThreadOwnerUserUUID": "string",
      "outOfOffice": true,
      "outOfOfficeStartDate": "string",
      "ssoFeatureEnabled": true,
      "isDealerMappedToSsoPartner": true,
      "isSsoPartnerMapped": true,
      "department": {
        "id": 0,
        "name": "string",
        "uuid": "string",
        "calendarUuid": "string",
        "brokerNumber": "string",
        "communicationGroup": "string",
        "dealer": {
          "id": 0,
          "name": "string",
          "uuid": "string",
          "isValid": true
        }
      },
      "role": {
        "roleName": "string",
        "roleAcronym": "string"
      }
    },
    "threeDSAuthenticationFailed": true
  }
}

Loading...