Balance transactions are the reflection of any movement of funds that affects the balance of an account. Oftentimes, a single financial transaction (like a payment) will result in the creation of many balance transactions in order to document the flow of funds between multiple accounts. Other financial transactions that result in balance transactions include refunds, disputes, and payouts.
List the balance transactions for your account. This endpoint supports pagination.
Successfully list balance transactions
{- "id": 1,
- "type": "array",
- "data": [
- {
- "id": "bt_xyz",
- "account_id": "acc_xyz",
- "amount": 100000,
- "available_on": "2021-01-01T12:00:00Z",
- "currency": "usd",
- "description": "string",
- "fee": 5000,
- "financial_transaction_id": "ft_xyz",
- "net": 600,
- "payout_id": "po_xyz",
- "source_id": "py_xyz",
- "source_type": "payment",
- "txn_type": "seller_payment",
- "created_at": "2021-01-01T12:00:00Z",
- "updated_at": "2021-01-01T12:00:00Z"
}
], - "page_info": {
- "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
- "has_next": false,
- "has_previous": false,
- "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
}
}
Get information about a balance transaction.
Successfully get a balance transaction
{- "id": 1,
- "type": "balance_transaction",
- "data": {
- "id": "bt_xyz",
- "account_id": "acc_xyz",
- "amount": 100000,
- "available_on": "2021-01-01T12:00:00Z",
- "currency": "usd",
- "description": "string",
- "fee": 5000,
- "financial_transaction_id": "ft_xyz",
- "net": 600,
- "payout_id": "po_xyz",
- "source_id": "py_xyz",
- "source_type": "payment",
- "txn_type": "seller_payment",
- "created_at": "2021-01-01T12:00:00Z",
- "updated_at": "2021-01-01T12:00:00Z"
}, - "page_info": "string"
}