Payout

WIP: A summary needs to be written for Payout

GET/v3/report/payment/payout

Payouts report

Payouts from SM Payments to the Shop report

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number Required
    Description
    the total number of records
  • Name
    availableCents
    Type
    number
    Description
  • Name
    inTransitCents
    Type
    number
    Description
  • Name
    pendingCents
    Type
    number
    Description
  • Name
    totalCents
    Type
    number
    Description

4xx 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 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
    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

GET
/v3/report/payment/payout
curl https://api.shopmonkey.cloud/v3/report/payment/payout \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/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"
      }
    }
  ]
}