List Payout Details

GET 
/openapi/2024-07/shoplazza-payment/payout/details

Return the payout details. Objects are sorted in descending order by creation date, with the most recently created objects shown first

Request

Query Parameters

created_at_min string

Start time for payout details (unix timestamp)

created_at_max string

End time for payout details (unix timestamp)

limit int32

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

currency string

Currency of the payout account

cursor string

cursor for pagination, use the cursor from the response for pagination

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

list object[]

List of payout details

Array [

idstring

Payout ID

store_idstring

Unique identifier for the store

created_atstring

Payout time (unix timestamp)

statusstring

Payout status (e.g., "succeeded","processing", "failed") succeeded: The payout was successfully completed, and funds have been transferred to the recipient. processing: The payout is currently in progress, and the final transfer of funds is pending confirmation. failed: The payout attempt failed, and the funds were not transferred.

currencystring

Payout currency

amountstring

Payout amount

bank_namestring

Bank name where the payout is received

last4string

Last 4 digits of the bank account receiving the payout

routing_numberstring

Routing number of the bank account receiving the payout

]

has_moreboolean

Indicator of whether there is more data for pagination

cursorstring

cursor for pagination

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "store_id": "string",
        "created_at": "string",
        "status": "string",
        "currency": "string",
        "amount": "string",
        "bank_name": "string",
        "last4": "string",
        "routing_number": "string"
      }
    ],
    "has_more": true,
    "cursor": "string"
  }
}

422

invalid parameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

{
  "code": "string",
  "message": "string"
}

Example

{
  "code": "InvalidParameter",
  "message": "Currency is required."
}

500

invalid parameter

application/json

Schema

Schema

codestring

error code

messagestring

error message

Example

{
  "code": "string",
  "message": "string"
}

Example

{
  "code": "InvalidParameter",
  "message": "wrong cursor"
}