Get Balance Transaction by Resource

GET /api/v1/balance_transactions/resource

Overview

Retrieves the balance transaction details associated with a specific resource type and ID, such as a payment intent or payout.

Authorization

Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY

Request Details

Request

curl "https://api-prod.paybytoken.io/api/v1/balance_transactions/resource?resource_type=payment_intent&resource_id=pay_pdICAC1vp3WkAKof4QkM" \
  -X GET \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

Request Parameters

Parameter	Type	Description
`resource_type`	string	Type of the associated resource, such as `payment_intent` or `payout`.
`resource_id`	string	ID of the associated resource.

Response Details

Response

The response returns a BalanceTransaction object containing the transaction details linked to the specified resource. See Balance Transactions Overview for the full object definition.

Example Response

{
    "id": "btx_pdMf5r3updqUKflE",
    "account_id": "p226968785",
    "balance_id": "bal_ofK07A66lSdtbXIa",
    "amount": "5.0",
    "currency": "USDC",
    "chain": "base",
    "description": null,
    "fee": "0.025",
    "total": "4.975",
    "fee_details": [
        {
            "type": "service_fee",
            "currency": "USDC",
            "description": "Service fee for payment intent",
            "amount": "0.025"
        },
        {
            "type": "network_fee",
            "currency": "USDC",
            "description": "Network fee for payment intent",
            "amount": "0.0"
        }
    ],
    "type": "credit",
    "resource_type": "payment_intent",
    "resource_id": "pay_pdICAC1vp3WkAKof4QkM",
    "remark": null,
    "created_at": "2025-09-25T10:35:10.000Z",
    "updated_at": "2025-09-25T18:35:10.000Z"
}

Errors

HTTP Status	Error Code	Description
404	404	No transaction found for the resource.
400	400	Invalid resource type or ID.
500	500	Internal server error.