Version: 4.0.2

Payout Response API

This API can be used to pull the details of a Payout for all sellers in the Marketplace. You can pull on either a Payout level or a Seller level.

Payout Level

`GET` Payout Details

Endpoint

/v4/marketplace/{marketplace_id}/payout/{payout_id}

Parameters

Field	Type	Description
`marketplace_id`	String	Unique identifier for the marketplace
`payout_id`	String	Unique identifier for the overall payout transaction

Response

Response Sample

{
  "status": "Settled",
  "payout_id": "Payout_id",
  "currency": "AUD",
  "marketplace_id": "000000-0000-0000-0000-000000000000",
  "seller_payouts": [
      {
          "payout_id": "Payout_id",
          "seller_id": "seller_id_1",
          "status": "Settled",
          "requested_amount": {
              "value": 1000
          }
      },
      {
          "payout_id": "Payout_id",
          "seller_id": "seller_id_2",
          "status": "Settled",
          "requested_amount": {
              "value": 1000
          }
      }
  ],
  "marketplace_fee_payout": {
      "requested_amount": {
          "value": 500
      },
      "net_amount": {
          "amount": {
              "value": 250
          },
          "payout_id": "Payout_id",
          "mpo_fee_account_id": "85645435-0000-0000-0000-000000",
          "status": "Settled"
      },
		"payouts_fee": {
          "amount": {
              "value": 250
          },
          "payout_id": "9900000-0000-0000-0000-000000",
          "mpo_fee_account_id": "23466-000-0000-000000",
          "status": "Settled"
      }
  }
}

Response Field Descriptions

Field	Data Type	Description
status	String	Current status of the transaction ("Settled")
payout_id	String	Unique identifier for the overall payout transaction
currency	String	Currency code for the transaction (AUD)
marketplace_id	String	Unique identifier for the marketplace
seller_payouts	Array	Collection of individual seller payout details
seller_payouts.payout_id	String	Unique identifier for specific seller payout
seller_payouts.seller_id	String	Unique identifier for the seller
seller_payouts.status	String	Current status of the seller payout ("Settled")
seller_payouts.requested_amount	Object	Container for requested amount information
seller_payouts.requested_amount.value	Number	Requested amount value for seller payout (10000)
marketplace_fee_payout	Object	Container for marketplace fee payout details
marketplace_fee_payout.requested_amount	Object	Container for requested fee amount information
marketplace_fee_payout.requested_amount.value	Number	Requested fee amount value (100)
marketplace_fee_payout.net_amount	Object	Container for net amount information
marketplace_fee_payout.net_amount.amount	Object	Container for amount details within net amount
marketplace_fee_payout.net_amount.amount.value	Number	Net amount value (100)
marketplace_fee_payout.net_amount.payout_id	String	Unique identifier for the net amount payout
marketplace_fee_payout.net_amount.mpo_fee_account_id	String	Identifier for marketplace operator fee account
marketplace_fee_payout.net_amount.status	String	Status of the net amount payout ("Settled")
marketplace_fee_payout.payouts_fee	Object	Container for payouts fee information
marketplace_fee_payout.payouts_fee.amount	Object	Container for amount details within payouts fee
marketplace_fee_payout.payouts_fee.amount.value	Number	Payouts fee value (100)
marketplace_fee_payout.payouts_fee.payout_id	String	Unique identifier for the payouts fee transaction
marketplace_fee_payout.payouts_fee.mpo_fee_account_id	String	Alternative marketplace operator fee account ID
marketplace_fee_payout.payouts_fee.status	String	Status of the payouts fee transaction ("Settled")

Seller Level

`GET` Seller Payout Details

Endpoint

/v4/marketplace/{marketplace_id}/payout/{payout_id}/sellers/{seller_id}

Parameters

Field	Data Type	Description
marketplace_id	String	Unique identifier for the marketplace
payout_id	String	Unique identifier for the overall payout transaction
seller_id	String	Unique identifier for the seller

Response

Response Sample

{
  "status": "Settled",
  "payout_id": "Payout_id",
  "currency": "AUD",
  "marketplace_id": "000000-0000-0000-0000-000000000000",
  "seller_payouts": [
      {
          "payout_id": "Payout_id",
          "seller_id": "seller_id_1",
          "status": "Settled",
          "requested_amount": {
              "value": 1000
          }
      }
  ],
  "marketplace_fee_payout": {
      "requested_amount": {
          "value": 500
      },
      "net_amount": {
          "amount": {
              "value": 250
          },
          "payout_id": "Payout_id",
          "mpo_fee_account_id": "85645435-0000-0000-0000-000000",
          "status": "Settled"
      },
  	"payouts_fee": {
          "amount": {
              "value": 250
          },
          "payout_id": "9900000-0000-0000-0000-000000",
          "mpo_fee_account_id": "23466-000-0000-000000",
          "status": "Settled"
      }
  }
}

Response Field Descriptions

Field	Data Type	Description
status	String	Current status of the transaction ("Settled")
payout_id	String	Unique identifier for the overall payout transaction
currency	String	Currency code for the transaction (AUD)
marketplace_id	String	Unique identifier for the marketplace
seller_payouts	Array	Collection of individual seller payout details
seller_payouts.payout_id	String	Unique identifier for specific seller payout
seller_payouts.seller_id	String	Unique identifier for the seller
seller_payouts.status	String	Current status of the seller payout ("Settled")
seller_payouts.requested_amount	Object	Container for requested amount information
seller_payouts.requested_amount.value	Number	Requested amount value for seller payout (10000)
marketplace_fee_payout	Object	Container for marketplace fee payout details
marketplace_fee_payout.requested_amount	Object	Container for requested fee amount information
marketplace_fee_payout.requested_amount.value	Number	Requested fee amount value (100)
marketplace_fee_payout.net_amount	Object	Container for net amount information
marketplace_fee_payout.net_amount.amount	Object	Container for amount details within net amount
marketplace_fee_payout.net_amount.amount.value	Number	Net amount value (100)
marketplace_fee_payout.net_amount.payout_id	String	Unique identifier for the net amount payout
marketplace_fee_payout.net_amount.mpo_fee_account_id	String	Identifier for marketplace operator fee account
marketplace_fee_payout.net_amount.status	String	Status of the net amount payout ("Settled")
marketplace_fee_payout.payouts_fee	Object	Container for payouts fee information
marketplace_fee_payout.payouts_fee.amount	Object	Container for amount details within payouts fee
marketplace_fee_payout.payouts_fee.amount.value	Number	Payouts fee value (100)
marketplace_fee_payout.payouts_fee.payout_id	String	Unique identifier for the payouts fee transaction
marketplace_fee_payout.payouts_fee.mpo_fee_account_id	String	Alternative marketplace operator fee account ID
marketplace_fee_payout.payouts_fee.status	String	Status of the payouts fee transaction ("Settled")

Payout Level​

GET Payout Details​

Endpoint​

Parameters​

Response​

Seller Level​

GET Seller Payout Details​

Endpoint​

Parameters​

Response​

Payout Level

`GET` Payout Details

Endpoint

Parameters

Response

Seller Level

`GET` Seller Payout Details

Endpoint

Parameters

Response