Integration

WIP: A summary needs to be written for Integration

DELETE/v3/integration/payment/manual/:id

Delete Payment

Delete manual payment

URL parameters

Name
id
Type
string Required
Description
the id for the object

Produces

The response content type: application/json

`200` Response

Name
data
Type
object
Description
Name
success
Type
boolean Required
Description

Properties for `data` object

Name
id
Type
string Required
Description
the id for the object

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE

/v3/integration/payment/manual/:id

curl https://api.shopmonkey.cloud/v3/integration/payment/manual/ID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X DELETE -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true
}

POST/v3/integration/payment/manual/charge

Record Payment

Records a payment manually

Body parameters

Consumes

The following content type is required: application/json

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
Payment schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
locationId
Type
string Required
Description
Name
orderId
Type
string Required
Description
Name
payerId
Type
string Required
Description
Name
statementId
Type
string Required
Description
Name
recordedDate
Type
string Required
Description
the date that the payment was recorded
Name
note
Type
string Required
Description
Name
userData
Type
object
Description
Name
status
Type
one of: Canceled, Failed, Pending, Succeeded Required
Description
Name
paymentType
Type
one of: Check, Cash, Card, Other, ACH, Financing, PayPal, Venmo, Zelle, Insurance, Warranty, Internal, Mechanical_Installment, Policy, Reconditioning, Vehicle_Service_Contract, Account_Receivable, BNPL, BNPL_Sunbit, Interac_e__Transfer Required
Description
Name
paymentMode
Type
one of: Manual, Online, InPerson Required
Description
Name
transactionType
Type
one of: Charge, Refund, Transfer, Dispute Required
Description
Name
amountCents
Type
integer Required
Description
amount charged or refuned
Name
refundedAmountCents
Type
integer Required
Description
amount refunded for charge transactions
Name
refunded
Type
boolean Required
Description
Name
refundReason
Type
one of: Duplicate, Fraudulent, RequestedByCustomer Required
Description
Name
chargeId
Type
string Required
Description
reference for original payment if transaction type is different from charge
Name
deposit
Type
boolean Required
Description
Name
checkNumber
Type
string Required
Description
Name
cardType
Type
string Required
Description
Name
cardDigits
Type
string Required
Description
Name
cardName
Type
string Required
Description
Name
cardConfirmation
Type
string Required
Description
Name
debitCard
Type
boolean Required
Description
Name
chargeFromPublicPage
Type
boolean Required
Description
Name
payoutId
Type
string Required
Description
Name
provider
Type
one of: Finix, FirstMile, Manual, Stripe, Sunbit Required
Description
Name
providerData
Type
object
Description
Name
receiptNumber
Type
integer Required
Description
Name
providerFee
Type
integer Required
Description
SM payments fee amount in cents on top of Stripe fee
Name
surchargeFee
Type
integer Required
Description
Name
transactionalFeeAmountCents
Type
integer Required
Description
amount charged as SM transactional fee (service fee)
Name
disputedPaymentId
Type
string Required
Description
if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment
Name
disputedStatus
Type
one of: Warning, NeedsResponse, UnderReview, Refunded, Won, Lost, Unknown Required
Description
Name
disputedReason
Type
string Required
Description
Name
disputedType
Type
one of: Deduction, Fee, ReversedDeduction, ReversedFee Required
Description
Name
bulkPaymentId
Type
string Required
Description
Name
imported
Type
boolean Required
Description
Name
interchangeFee
Type
integer Required
Description
0 = no fees yet, null = there will be no fees
Name
duesAndAssessmentsFee
Type
number Required
Description
0 = no fees yet, null = there will be no fees

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/integration/payment/manual/charge

curl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "orderId": "orderId",
    "payerId": null,
    "statementId": null,
    "recordedDate": null,
    "note": "note",
    "status": "status",
    "paymentType": "paymentType",
    "paymentMode": "paymentMode",
    "transactionType": "transactionType",
    "amountCents": 1,
    "refundedAmountCents": null,
    "refunded": true,
    "refundReason": null,
    "chargeId": null,
    "deposit": true,
    "checkNumber": null,
    "cardType": null,
    "cardDigits": null,
    "cardName": null,
    "cardConfirmation": null,
    "debitCard": true,
    "chargeFromPublicPage": true,
    "provider": null,
    "receiptNumber": 1,
    "providerFee": null,
    "transactionalFeeAmountCents": null,
    "disputedPaymentId": null,
    "disputedStatus": null,
    "disputedReason": null,
    "disputedType": null,
    "bulkPaymentId": null
  }
}

POST/v3/integration/payment/manual/charge/bulk

Record Bulk Payment

Records a bulk payment manually

Body parameters

Consumes

The following content type is required: application/json

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
array Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/integration/payment/manual/charge/bulk

curl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "orderId": "orderId",
      "payerId": null,
      "statementId": null,
      "recordedDate": null,
      "note": "note",
      "status": "status",
      "paymentType": "paymentType",
      "paymentMode": "paymentMode",
      "transactionType": "transactionType",
      "amountCents": 1,
      "refundedAmountCents": null,
      "refunded": true,
      "refundReason": null,
      "chargeId": null,
      "deposit": true,
      "checkNumber": null,
      "cardType": null,
      "cardDigits": null,
      "cardName": null,
      "cardConfirmation": null,
      "debitCard": true,
      "chargeFromPublicPage": true,
      "payoutId": null,
      "provider": null,
      "receiptNumber": 1,
      "providerFee": null,
      "transactionalFeeAmountCents": null,
      "disputedPaymentId": null,
      "disputedStatus": null,
      "disputedReason": null,
      "disputedType": null,
      "bulkPaymentId": null
    }
  ]
}

PUT/v3/integration/payment/manual/charge/bulk/:id

Update Bulk Payment

Update a bulk payment manually

URL parameters

Name
id
Type
string Required
Description
the id for the object

Body parameters

Consumes

The following content type is required: application/json

Name
payerId
Type
string
Description
Name
statementId
Type
string
Description
Name
recordedDate
Type
string
Description
the date that the payment was recorded
Name
note
Type
string
Description
Name
userData
Type
object
Description
Name
status
Type
one of: Canceled, Failed, Pending, Succeeded
Description
Name
paymentType
Type
one of: Check, Cash, Card, Other, ACH, Financing, PayPal, Venmo, Zelle, Insurance, Warranty, Internal, Mechanical_Installment, Policy, Reconditioning, Vehicle_Service_Contract, Account_Receivable, BNPL, BNPL_Sunbit, Interac_e__Transfer
Description
Name
paymentMode
Type
one of: Manual, Online, InPerson
Description
Name
transactionType
Type
one of: Charge, Refund, Transfer, Dispute
Description
Name
refundedAmountCents
Type
integer
Description
amount refunded for charge transactions
Name
refundReason
Type
one of: Duplicate, Fraudulent, RequestedByCustomer
Description
Name
chargeId
Type
string
Description
reference for original payment if transaction type is different from charge
Name
deposit
Type
boolean
Description
Name
checkNumber
Type
string
Description
Name
cardType
Type
string
Description
Name
cardDigits
Type
string
Description
Name
cardName
Type
string
Description
Name
cardConfirmation
Type
string
Description
Name
debitCard
Type
boolean
Description
Name
chargeFromPublicPage
Type
boolean
Description
Name
payoutId
Type
string
Description
Name
provider
Type
one of: Finix, FirstMile, Manual, Stripe, Sunbit
Description
Name
providerData
Type
object
Description
Name
receiptNumber
Type
integer
Description
Name
providerFee
Type
integer
Description
SM payments fee amount in cents on top of Stripe fee
Name
surchargeFee
Type
integer
Description
Name
transactionalFeeAmountCents
Type
integer
Description
amount charged as SM transactional fee (service fee)
Name
disputedPaymentId
Type
string
Description
if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment
Name
disputedStatus
Type
one of: Warning, NeedsResponse, UnderReview, Refunded, Won, Lost, Unknown
Description
Name
disputedReason
Type
string
Description
Name
disputedType
Type
one of: Deduction, Fee, ReversedDeduction, ReversedFee
Description
Name
bulkPaymentId
Type
string
Description
Name
interchangeFee
Type
integer
Description
0 = no fees yet, null = there will be no fees
Name
duesAndAssessmentsFee
Type
number
Description
0 = no fees yet, null = there will be no fees
Name
orders
Type
array
Description

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
array Required
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT

/v3/integration/payment/manual/charge/bulk/:id

curl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk/ID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X PUT -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "orderId": "orderId",
      "payerId": null,
      "statementId": null,
      "recordedDate": null,
      "note": "note",
      "status": "status",
      "paymentType": "paymentType",
      "paymentMode": "paymentMode",
      "transactionType": "transactionType",
      "amountCents": 1,
      "refundedAmountCents": null,
      "refunded": true,
      "refundReason": null,
      "chargeId": null,
      "deposit": true,
      "checkNumber": null,
      "cardType": null,
      "cardDigits": null,
      "cardName": null,
      "cardConfirmation": null,
      "debitCard": true,
      "chargeFromPublicPage": true,
      "payoutId": null,
      "provider": null,
      "receiptNumber": 1,
      "providerFee": null,
      "transactionalFeeAmountCents": null,
      "disputedPaymentId": null,
      "disputedStatus": null,
      "disputedReason": null,
      "disputedType": null,
      "bulkPaymentId": null
    }
  ]
}

DELETE/v3/integration/payment/manual/charge/bulk/:id

Delete Bulk Payment

Delete a bulk payment manually

URL parameters

Name
id
Type
string Required
Description
the id for the object

Produces

The response content type: application/json

`200` Response

Name
data
Type
object Required
Description
Name
success
Type
boolean Required
Description

Properties for `data` object

Name
bulkPaymentId
Type
string
Description

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE

/v3/integration/payment/manual/charge/bulk/:id

curl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk/ID \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X DELETE -H 'Content-Type: application/json' \ 
  --data '{}'

Example Response
application/json

{
  "data": {
    "bulkPaymentId": "bulkPaymentId"
  },
  "success": true
}

POST/v3/integration/payment/manual/refund

Create

Create an

Body parameters

Consumes

The following content type is required: application/json

Name
chargeId
Type
string Required
Description
The payment id to refund
Name
recordedDate
Type
string Required
Description
the date that the payment was recorded
Name
paymentType
Type
one of: Check, Cash, Card, Other, ACH, Financing, PayPal, Venmo, Zelle, Insurance, Warranty, Internal, Mechanical_Installment, Policy, Reconditioning, Vehicle_Service_Contract, Account_Receivable, BNPL, BNPL_Sunbit, Interac_e__Transfer Required
Description
Name
amountCents
Type
integer Required
Description
amount charged or refuned
Name
refundReason
Type
one of: Duplicate, Fraudulent, RequestedByCustomer Required
Description
Name
note
Type
string
Description

Produces

The response content type: application/json

`200` Response

Name
code
Type
string
Description
The error code
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if success = false
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message
Name
data
Type
object Required
Description
Payment schema

Properties for `data` object

Name
id
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
updatedDate
Type
string Required
Description
Name
companyId
Type
string Required
Description
Name
locationId
Type
string Required
Description
Name
orderId
Type
string Required
Description
Name
payerId
Type
string Required
Description
Name
statementId
Type
string Required
Description
Name
recordedDate
Type
string Required
Description
the date that the payment was recorded
Name
note
Type
string Required
Description
Name
userData
Type
object
Description
Name
status
Type
one of: Canceled, Failed, Pending, Succeeded Required
Description
Name
paymentType
Type
one of: Check, Cash, Card, Other, ACH, Financing, PayPal, Venmo, Zelle, Insurance, Warranty, Internal, Mechanical_Installment, Policy, Reconditioning, Vehicle_Service_Contract, Account_Receivable, BNPL, BNPL_Sunbit, Interac_e__Transfer Required
Description
Name
paymentMode
Type
one of: Manual, Online, InPerson Required
Description
Name
transactionType
Type
one of: Charge, Refund, Transfer, Dispute Required
Description
Name
amountCents
Type
integer Required
Description
amount charged or refuned
Name
refundedAmountCents
Type
integer Required
Description
amount refunded for charge transactions
Name
refunded
Type
boolean Required
Description
Name
refundReason
Type
one of: Duplicate, Fraudulent, RequestedByCustomer Required
Description
Name
chargeId
Type
string Required
Description
reference for original payment if transaction type is different from charge
Name
deposit
Type
boolean Required
Description
Name
checkNumber
Type
string Required
Description
Name
cardType
Type
string Required
Description
Name
cardDigits
Type
string Required
Description
Name
cardName
Type
string Required
Description
Name
cardConfirmation
Type
string Required
Description
Name
debitCard
Type
boolean Required
Description
Name
chargeFromPublicPage
Type
boolean Required
Description
Name
payoutId
Type
string Required
Description
Name
provider
Type
one of: Finix, FirstMile, Manual, Stripe, Sunbit Required
Description
Name
providerData
Type
object
Description
Name
receiptNumber
Type
integer Required
Description
Name
providerFee
Type
integer Required
Description
SM payments fee amount in cents on top of Stripe fee
Name
surchargeFee
Type
integer Required
Description
Name
transactionalFeeAmountCents
Type
integer Required
Description
amount charged as SM transactional fee (service fee)
Name
disputedPaymentId
Type
string Required
Description
if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment
Name
disputedStatus
Type
one of: Warning, NeedsResponse, UnderReview, Refunded, Won, Lost, Unknown Required
Description
Name
disputedReason
Type
string Required
Description
Name
disputedType
Type
one of: Deduction, Fee, ReversedDeduction, ReversedFee Required
Description
Name
bulkPaymentId
Type
string Required
Description
Name
imported
Type
boolean Required
Description
Name
interchangeFee
Type
integer Required
Description
0 = no fees yet, null = there will be no fees
Name
duesAndAssessmentsFee
Type
number Required
Description
0 = no fees yet, null = there will be no fees

`4xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

`5xx` Response

Name
code
Type
string
Description
The error code
Name
data
Type
undefined
Description
An optional object containing relevant error data
Name
documentation_url
Type
string
Description
An optional link to the documentation for the error
Name
message
Type
string
Description
the error message if not successful
Name
success
Type
boolean Required
Description
if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST

/v3/integration/payment/manual/refund

curl https://api.shopmonkey.cloud/v3/integration/payment/manual/refund \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -H 'Content-Type: application/json' \ 
  --data '{ "chargeId" : "value", "recordedDate" : "value", "paymentType" : "value", "amountCents" : 0, "refundReason" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "orderId": "orderId",
    "payerId": null,
    "statementId": null,
    "recordedDate": null,
    "note": "note",
    "status": "status",
    "paymentType": "paymentType",
    "paymentMode": "paymentMode",
    "transactionType": "transactionType",
    "amountCents": 1,
    "refundedAmountCents": null,
    "refunded": true,
    "refundReason": null,
    "chargeId": null,
    "deposit": true,
    "checkNumber": null,
    "cardType": null,
    "cardDigits": null,
    "cardName": null,
    "cardConfirmation": null,
    "debitCard": true,
    "chargeFromPublicPage": true,
    "provider": null,
    "receiptNumber": 1,
    "providerFee": null,
    "transactionalFeeAmountCents": null,
    "disputedPaymentId": null,
    "disputedStatus": null,
    "disputedReason": null,
    "disputedType": null,
    "bulkPaymentId": null
  }
}

Integration

Delete Payment

URL parameters

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Record Payment

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Record Bulk Payment

Body parameters

Consumes

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Update Bulk Payment

URL parameters

Body parameters

Consumes

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Delete Bulk Payment

URL parameters

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Create

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json