v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB

Settlements

Settlement: Show

Retrieves a single settlement by its id, including a breakdown of payments, refunds, fees, corrections, and disbursements.

get/settlements/{id}

Path parameters

idstring required

A unique 25-character alphanumeric resource identifier.

Response

200 response

idstring required

A unique 25-character alphanumeric resource identifier.

resource'settlement' required

Resource type name, always "settlement".

referencestring required

Human-readable reference code for this settlement.

status'pending' | 'paid' | 'cancelled' | 'bounced' | 'suspended' required

merchant_namestring required

Name of the merchant associated with this settlement.

company_namestring nullable required

Legal company name of the merchant, or null if not set.

cyclestring required

Settlement cycle identifier (e.g. the week or month period covered).

transaction_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND' required

3-letter ISO currency code.

fee_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

fee_tax_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

settlement_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

fx_currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND' required

3-letter ISO currency code.

fx_conversion_ratestring required

Exchange rate applied for FX conversion.

fx_conversion_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

bank_transfer_fee_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

remittance_amount_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

cutoff_timestring date-time required

Cutoff timestamp for transactions included in this settlement.

created_atstring date-time required

Timestamp when this settlement record was created.

Example response

{
  "currency": "JPY",
  "fx_currency": "JPY"
}