Payment
WIP: A summary needs to be written for Payment
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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/integration/payment/manual/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true
}
Download PDF
Get an payment as PDF document
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Example Request
curl https://api.shopmonkey.cloud/v3/integration/payment/ID/pdf \
-H "Authorization: Bearer ${SM_TOKEN}"
Send Payment Receipt
Send a payment receipt to customers
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
emailIds
- Type
- array Required
- Description
- An array of ids of customers emails
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/integration/payment/ID/email \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "emailIds" : [] }'
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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/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
}
}
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 Requestapplication/json
curl https://api.shopmonkey.cloud/v3/integration/payment/manual/charge/bulk \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/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
}
]
}
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 Requestapplication/json
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 Responseapplication/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 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 Requestapplication/json
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 Responseapplication/json
{
"data": {
"bulkPaymentId": "bulkPaymentId"
},
"success": true
}
Download PDF
Get purchase order as PDF document
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Example Request
curl https://api.shopmonkey.cloud/v3/purchase_order/ID/pdf \
-H "Authorization: Bearer ${SM_TOKEN}"
Payments report
All Payments report
Produces
The response produces the following content types: application/json
, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- 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
meta
- Type
- object
- Description
- 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
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
sums
- Type
- one of: any, any
- Description
- Name
total
- Type
- number
- Description
- the total number of records
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
curl https://api.shopmonkey.cloud/v3/report/payment \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"orderId": "orderId",
"recordedDate": null,
"note": "note",
"paymentType": "paymentType",
"amountCents": 1,
"cardType": null,
"order": {
"id": "id",
"number": 1,
"name": null,
"generatedVehicleName": null,
"totalCostCents": 1,
"paidCostCents": 1,
"remainingCostCents": null
},
"location": {
"id": "id",
"name": "name"
},
"payer": {
"firstName": null,
"lastName": null,
"companyName": null,
"normalizedFirstName": null,
"normalizedLastName": null
}
}
]
}
Payment Transactions report
Payment transactions report, for operations paid by card (using the payment provider)
Produces
The response produces the following content types: application/json
, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- 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
meta
- Type
- object
- Description
- 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
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
sums
- Type
- object
- Description
- Name
total
- Type
- number
- Description
- the total number of records
- Name
totalAmount
- Type
- number
- Description
- Name
totalFee
- Type
- number
- Description
- Name
totalNet
- Type
- number
- Description
- Name
totalSurcharge
- Type
- number
- 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
curl https://api.shopmonkey.cloud/v3/report/payment/transaction \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"paymentMode": "paymentMode",
"amountCents": 1,
"cardType": null,
"cardDigits": null,
"provider": null,
"providerFee": null,
"net": 1,
"order": {
"id": "id",
"number": 1,
"name": null
},
"location": {
"id": "id",
"name": "name"
},
"payer": {
"id": "id",
"firstName": null,
"lastName": null,
"normalizedFirstName": null,
"normalizedLastName": null
}
}
]
}
Payouts report
Payouts from SM Payments to the Shop report
Produces
The response produces the following content types: application/json
, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- 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
meta
- Type
- object
- Description
- 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
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
sums
- Type
- object
- Description
- Name
total
- Type
- number
- Description
- the total number of records
- Name
availableCents
- Type
- number
- Description
- Name
inTransitCents
- Type
- number
- Description
- Name
pendingCents
- Type
- number
- Description
- Name
totalAmountCents
- Type
- number
- Description
- Name
totalCents
- Type
- number
- 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
curl https://api.shopmonkey.cloud/v3/report/payment/payout \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": [
{
"id": "id",
"createdDate": "createdDate",
"updatedDate": "updatedDate",
"arrivalDate": null,
"companyId": "companyId",
"locationId": "locationId",
"provider": "provider",
"amountCents": 1,
"status": "status",
"description": null,
"error": null,
"location": {
"id": "id",
"name": "name"
}
}
]
}
Download PDF
Get an payment as PDF document
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Example Request
curl https://api.shopmonkey.cloud/v3/integration/shared_payment/ID/pdf \
-H "Authorization: Bearer ${SM_TOKEN}"
Send Payment Receipt
Send a payment receipt to customers
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
emailIds
- Type
- array Required
- Description
- An array of ids of customers emails
Example Requestapplication/json
curl https://api.shopmonkey.cloud/v3/integration/shared_payment/ID/email \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "emailIds" : [] }'