Balance Transaction
GET
/balance_transactions/{balance_transaction_id}Retrieve
Retrieve a specific balance transaction (ledger entry) by ID.
Shows amount, state, category, event type, and related IDs.
Requires: Bearer token, X-Country header.
Request
Example
curl -X GET 'https://api.paycose.com/api/v1/app1/platform/wallet/balance_transactions/{{balance_transaction_id}}' \
-H 'X-Session-Token: {{session_token}}' \
-H 'X-Country: {{country}}' \
-H 'X-Test-Mode: {{x_test_mode}}'Headers
| Name | Value | Description |
|---|---|---|
| X-Session-Token | {{session_token}} | |
| X-Country | {{country}} | |
| X-Test-Mode | {{x_test_mode}} | true=wallet_test, false=wallet_live (default). Toggle the x_test_mode collection variable to flip every applicable request. |
Responses
200200 OK
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Body
{
"id": "<string>",
"object": "<string>",
"livemode": false,
"created_at": null,
"updated_at": null,
"amount": 0,
"currency": "<string>",
"scaling_factor": 0,
"state": "<string>",
"description": "<string>",
"original_amount": 0,
"original_currency": "<string>",
"exchange_rate": 0.0,
"balance_id": "<string>",
"account": "<string>",
"event_type": "<string>",
"event_id": "<string>",
"parent_event_type": "<string>",
"parent_event_id": "<string>",
"transfer_id": "<string>",
"journal_id": "<string>",
"category": "<string>",
"forex_quote_id": "<string>",
"available_on": "<RFC3339 timestamp>",
"type": "<string>",
"source": "<string>",
"fee": 0,
"fee_details": [
{
"type": "<string>",
"amount": 0,
"currency": "<string>",
"application": "<string>"
}
],
"net": 0,
"gross_amount": 0,
"reporting_category": "<string>",
"plane": "<string>",
"record_only": false,
"balance": {
"id": "<string>",
"object": "<string>",
"livemode": false,
"created_at": null,
"updated_at": null,
"customer_id": "<string>",
"account": "<string>",
"currency": "<string>",
"name": "<string>",
"available": 0,
"hold": 0,
"scaling_factor": 0,
"description": "<string>",
"customer": {
"id": "<string>",
"object": "<string>",
"livemode": false,
"created_at": null,
"updated_at": null,
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"shipping": {
"name": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"state": "<string>"
}
},
"is_system": false,
"is_application_customer": false,
"capabilities": {
"charge": false,
"transfer": false,
"payout": false
},
"tax_ids": [
{
"type": "<string>",
"value": "<string>",
"country": "<string>",
"verification_status": "<string>"
}
],
"metadata": {},
"labels": "<core.Labels>",
"invoice_settings": {},
"tax_exempt": "<string>",
"preferred_locales": [
"<string>"
],
"business_name": "<string>",
"currency": "<string>"
}
},
"transfer": null
}400400 Bad Request
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
Body
{
"object": "error",
"code": "<string>",
"key": "<string>",
"i18n_key": "<string>",
"message": "<string>",
"request_id": "<string>"
}