Fetch a Settlement
Retrieve the details of an existing Settlement.
Headers
Specify the API version of your request. For more details, see Versioning.
Response
A single Settlement
The ID of the resource.
Timestamp of when the object was created.
Timestamp of when the object was last updated.
ID of the Application the resource was created under.
ISO 4217 3-letter currency code.
ID of the Payment Instrument where funds will be sent.
Details how funds will be dispersed in the Funding Transfer (usually null).
The ID of the Identity used to create the Settlement resource.
Returns true if the Settlement contains items that were removed from a previous Settlement.
The ID of the Merchant used to create the Settlement resource.
The amount in cents that will be deposited into the merchant's bank account.
The type of Payment Instrument used in the Funding Transfer (or the original payment).
The ID of the Payout Profile that was used to generate the Settlement.
The name of the processor.
The status of the Settlement. Merchants only receive payouts when Settlements are APPROVED. For more information, see Payouts.
Include up to 50 key: value pairs to annotate requests with custom metadata.
- Maximum character length for individual keys is 40.
- Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
The total amount of the Settlement in cents.
The sum of the fees in the Settlement.
The sum of the fees in the Settlement, including subscription billing fees.
The end of the settlement window period.
The start of the settlement window period.
The type of Settlement.
Example response
{
"destination": "PIxxxxxxxxxxxxxxxxxx"
}