Payments
- Transactions
- Buyers
- Checkout Sessions
- Payment links
- Payment options
- Payouts
- Refunds
- Sessions
- Settlement records
Instruments
- Card schemes
- Digital wallets
- Gift cards
- Payment methods
- Payment method definitions
Vault
- Account updater
- Network tokens
- Payment service tokens
- Vault Forward
- Vault Forward endpoints
- Vault Forward authentication
Connections
- All services
- Payment services
- Digital wallets
- Anti-fraud services
Dashboard
- Flow
- Reports
- Report executions
List settlements for transaction
Gets settlements for a given transaction.
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/settlements \
--header 'Authorization: Bearer <token>'{
"items": [
{
"type": "settlement",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"created_at": "2024-04-01T19:23:00.000+00:00",
"updated_at": "2024-04-01T19:23:00.000+00:00",
"posted_at": "2024-03-30T10:25:00.000+00:00",
"ingested_at": "2013-04-01T01:01:00.000+00:00",
"currency": "USD",
"amount": 1299,
"exchange_rate": 0.95,
"commission": 5,
"interchange": 5,
"markup": 10,
"scheme_fee": 5,
"payment_service_report_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"payment_service_report_file_ids": [
"0302e601-d2c3-42b2-9825-9457145331ae",
"7deec061-71a5-435f-beae-40f35820ca67"
],
"transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9"
}
]
}This endpoint requires the transactions.read scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID for the transaction to get the information for.
Response
A list of settlements.
A list of settlements.
A settlement record.
The type of this resource. Is always settlement.
settlement The unique identifier for this settlement.
The ID of the merchant account to which this settlement belongs to.
The date and time when this settlement was created in our system.
The date and time when this settlement was last updated.
The date and time when this settlement occurred.
The date and time when information about this settlement was ingested into our system.
The currency code of this settlement in ISO 4217 three-letter code format.
The net amount of this settlement.
The exchange rate used to convert amounts from the processing currency to the settlement currency.
The total commission of this settlement, expressed in currency.
The interchange fee of this settlement, expressed in currency.
The markup of this settlement by the acquirer, expressed in currency.
The scheme fee of this settlement, expressed in currency.
The ID of the payment service report containing this settlement.
The list of payment service report file IDs that make up the payment service report containing this settlement.
The ID of the transaction associated with this settlement.
Was this page helpful?
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/transactions/{transaction_id}/settlements \
--header 'Authorization: Bearer <token>'{
"items": [
{
"type": "settlement",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"created_at": "2024-04-01T19:23:00.000+00:00",
"updated_at": "2024-04-01T19:23:00.000+00:00",
"posted_at": "2024-03-30T10:25:00.000+00:00",
"ingested_at": "2013-04-01T01:01:00.000+00:00",
"currency": "USD",
"amount": 1299,
"exchange_rate": 0.95,
"commission": 5,
"interchange": 5,
"markup": 10,
"scheme_fee": 5,
"payment_service_report_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
"payment_service_report_file_ids": [
"0302e601-d2c3-42b2-9825-9457145331ae",
"7deec061-71a5-435f-beae-40f35820ca67"
],
"transaction_id": "fe26475d-ec3e-4884-9553-f7356683f7f9"
}
]
}