Payouts
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2019-10/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2019-10/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2019-10/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2019-10/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2019-10/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-01/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2020-01/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2020-01/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2020-01/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2020-01/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-04/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2020-04/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2020-04/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2020-04/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2020-04/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-07/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2020-07/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2020-07/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2020-07/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2020-07/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-10/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2020-10/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2020-10/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2020-10/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2020-10/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2021-01/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2021-01/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2021-01/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2021-01/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2021-01/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2021-04/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2021-04/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2021-04/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2021-04/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2021-04/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/2021-07/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/2021-07/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/2021-07/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/2021-07/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/2021-07/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}
What you can do with Payouts
The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:
- GET /admin/api/unstable/shopify_payments/payouts.json?date_max=2012-11-12 Return a list of all payouts
- GET /admin/api/unstable/shopify_payments/payouts/{payout_id}.json Return a single payout
Payouts properties
id |
The unique identifier of the payout |
status |
The transfer status of the payout. The value will be one of the following:
|
date |
The date (ISO 8601 format) when the payout was issued. |
currency |
The ISO 4217 currency code of the payout. |
amount |
The total amount of the payout, in a decimal formatted string. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
since_id
|
Filter the response to payouts made after the specified ID. |
last_id
|
Filter the response to payouts made before the specified ID. |
date_min
|
Filter the response to payouts made inclusively after the specified date. |
date_max
|
Filter the response to payouts made inclusively before the specified date. |
date
|
Filter the response to payouts made on the specified date. |
status
|
Filter the response to payouts made with the specified status. |
List all payouts up to a specified date
GET /admin/api/unstable/shopify_payments/payouts.json?date_max=2012-11-12
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
List all payouts ordered newest to oldest
GET /admin/api/unstable/shopify_payments/payouts.json
View Response
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 854088011,
"status": "scheduled",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 512467833,
"status": "failed",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 710174591,
"status": "paid",
"date": "2012-12-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 974708905,
"status": "paid",
"date": "2012-11-13",
"currency": "CAD",
"amount": "51.69",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "6.46",
"charges_gross_amount": "58.15",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
]
}
Retrieves a single payout by id
GET /admin/api/unstable/shopify_payments/payouts/623721858.json
View Response
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}