savePaymentMethodAttempt

ApiScope: payment.method.attempt.update
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required
paymentMethodAttemptUuid string required

application/json

Request Body required

paymentMethodAttemptUuid string
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
creationTime date-time
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

cash object

batchNumber string

methodType string

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

paymentProviderName string
transactionSource string

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

departmentUuid string
last4digits 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
]
paymentMethodAttempt object
id int64
uuid string
status string
Possible values: [Created, Processing, Successful, Failed, Exception, GatewayException]
paymentCustomer object
customerUuid string
firstName string
middleName string
lastName string
company string
paymentDealer object
dealerUuid string
name string
paymentUser object
id int64
dealerAssociateUUID string
userUUID string
dealerDepartmentUUID string
deviceId int64
paymentMethodAttemptAttributes object
property name* string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "paymentMethodAttempt": {
    "id": 0,
    "uuid": "string",
    "status": "Created",
    "paymentCustomer": {
      "customerUuid": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "company": "string"
    },
    "paymentDealer": {
      "dealerUuid": "string",
      "name": "string"
    },
    "paymentUser": {
      "id": 0,
      "dealerAssociateUUID": "string",
      "userUUID": "string",
      "dealerDepartmentUUID": "string"
    },
    "deviceId": 0,
    "paymentMethodAttemptAttributes": {}
  }
}

Loading...