Payout Request API

POST Create Payout

The MPO can use this API to inform Deutsche Bank of which Sellers to disburse funds to and how much.

Endpoint

/v4/marketplace/payout

Body

Sample Request

{
  	"marketplace_id": "0000000-0000-0000-0000-000000000000",
  	"number_of_sellers": 1,
  	"total_disbursement": {
  		"value": {
  			amount: 1000
  		}
  	},
  	"sellers": [
  		{
  			"seller_id": "e67a0b0b-695a-47f9-ad93-680ec190c70c",
  			"amount": {
  				"value": {
  					amount: 1000
  				}
  			}
  		}, ...
  	],
  	"fee": {
  		"value": {
  			amount: 20
  		}
  	},
  	"country_code": "AU",
  	"currency": "AUD",
  	"timezone": "Australia/Sydney"
}

Request Field Descriptions

Field	Type	Description
marketplace_id	String	Unique identifier for the marketplace
number_of_sellers	Number	Number of sellers within the Payout
total_disbursement	Dictionary	Aggregate disbursement amount for all sellers included in this payout
value.amount	Number	The total payout value, eg. 1000
sellers	Array of Dictionaries	List of sellers included and their disbursal amounts included in this Payout
seller_id	String	Unique identifier for the seller included in the payout
seller_id.value .amount	Number	The value of the disbursal for the seller, eg. 100
fee	Object	Fees deducted at Payout for the Seller
fee.value	Object	Contains information on the Value of the fees for the seller
fee.value.amount	Number	The value of the fee for the disbursal, eg.20
country_code	String	Country code of the marketplace
currency	String	Currency used in the marketplace
timezone	String	Timezone of the marketplace

Response

Sample Response

{
  "status": "Pending",
  "payout_id": "9899900-0000-0000-0000-000000000000",
  "currency": "AUD",
  "marketplace_id": "0000000-0000-0000-0000-000000000000",
  "seller_payouts": [
  	{
  		"payout_id": "9876000-0000-0000-0000-000000000000",
  		"seller_id": "e67a0b0b-695a-47f9-ad93-680ec190c70c",
  		"status": "Pending",
  		"requested_amount": {
  			"value": 20
  		}
  	}
  ],
  "marketplace_fee_payout": {
  	"requested_amount": {
  		"value": 20
  	},
  	"net_amount": {
  		"value": 200,
  		"payout_id": "9876000-0000-0000-0000-000000000000",
  		"mpo_fee_account_id": "5600000-0000-0000-0000-000000000000",
  		"status": "Pending"
  	},
  	"payouts_fee": {
  		"value": 455,
  		"payout_id": "9876000-0000-0000-0000-000000000000",
  		"mpo_fee_account_id": "9900000-0000-0000-0000-000000000000",
  		"status": "Pending"
  	}
  }
}

Response Field Definitions

Field	Data Type	Description
status	String	Current status of the transaction ("Pending")
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 included in this Payout
seller_payouts.payout_id	String	Unique identifier for specific seller payout included in this Payout
seller_payouts[].seller_id	String	Unique identifier for the seller
seller_payouts.status	String	Current status of the seller payout ("Pending")
seller_payouts.requested_amount	Object	Container for requested amount information
seller_payouts.requested_amount.value	Number	Requested amount value for seller payout eg.20
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, eg.20
marketplace_fee_payout.net_amount	Object	Container for net amount information
marketplace_fee_payout.net_amount.value	Number	Net amount value, eg.200
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 ("Pending")
marketplace_fee_payout.payouts_fee	Object	Container for payouts fee information
marketplace_fee_payout.payouts_fee.value	Number	Payouts fee value, eg.455
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 ("Pending")