The InboundTransfer object

Attributes

idstring
Unique identifier for the InboundTransfer.

objectstring, value is "v2.money_management.inbound_transfer"
String representing the object’s type. Objects of the same type share the same value of the object field.

amountobject
The amount in specified currency that will land in the FinancialAccount balance.

createdtimestamp
Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

descriptionstring
A freeform text field provided by user, containing metadata.

fromobject
A nested object containing information about the origin of the InboundTransfer.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

receipt_urlnullable string
A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

toobject
A nested object containing information about the destination of the InboundTransfer.

transfer_historyarray of objects
A list of history objects, representing changes in the state of the InboundTransfer.

The InboundTransfer object

{
  "id": "ibt_test_61Q58XwKMHh5ha3MI16Nr2cJ8cSQabKn4q38nZ59E6yO",
  "object": "v2.money_management.inbound_transfer",
  "amount": {
    "value": 101,
    "currency": "usd"
  },
  "created": "2024-03-18T18:07:12.619131Z",
  "description": "earnings",
  "from": {
    "debited": {
      "value": 101,
      "currency": "usd"
    },
    "payment_method": {
      "type": "payment_methods.us_bank_account",
      "us_bank_account": "usba_test_61P22mHGGhTkqVEx416Nr2cJ8cSQabKn4q38nZ59E7ea"
    }
  },
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk5yMmNKOGNTUWFiS240cTM4blo1OUUohIbirwYyBvlQ2PtS3zpGlI2ZkpO8-dpYhb3KfWs1FlYI9eX2I94gJoeJHXOR0QwwesVCRnQwRgsUQqGFloqKV7McODKkoVKAMiuB5lD9htcDuxRtDA",
  "to": {
    "credited": {
      "value": 101,
      "currency": "usd"
    },
    "financial_account": "fa_test_65Nyg0pdsXOSN32kkjg16Nr2cJ8cSQabKn4q38nZ59E50y"
  },
  "transfer_history": [
    {
      "id": "ibthe_test_61Q58Xw5weaazmsWj16Nr2cJ8cSQabKn4q38nZ59E52W",
      "bank_debit_queued": {},
      "created": "2024-03-18T18:07:12.617Z",
      "effective_at": "2024-03-18T18:07:12.617Z",
      "level": "canonical",
      "type": "bank_debit_queued"
    },
    {
      "id": "ibthe_test_61Q58Y2iAWn3U9kNW16Nr2cJ8cSQabKn4q38nZ59EXzc",
      "bank_debit_processing": {},
      "created": "2024-03-18T18:07:18.403Z",
      "effective_at": "2024-03-18T18:07:18.403Z",
      "level": "canonical",
      "type": "bank_debit_processing"
    },
    {
      "id": "ibthe_test_61Q58Y7wNh292msCP16Nr2cJ8cSQabKn4q38nZ59EPz6",
      "bank_debit_succeeded": {},
      "created": "2024-03-18T18:07:23.103Z",
      "effective_at": "2024-03-18T18:07:23.103Z",
      "level": "canonical",
      "type": "bank_debit_succeeded"
    }
  ]
}

Create an InboundTransfer object v2

Learn more about calling API v2 endpoints.

InboundTransfers APIs are used to create, retrieve or list InboundTransfers.

Parameters

amountobjectRequired
The amount, in specified currency, by which the FinancialAccount balance will increase due to the InboundTransfer.

fromobjectRequired
Object containing details about where the funds will originate from.

toobjectRequired
Object containing details about where the funds will land.

descriptionstring
An optional, freeform description field intended to store metadata.

Returns

Response attributes

idstring
Unique identifier for the InboundTransfer.

objectstring, value is "v2.money_management.inbound_transfer"
String representing the object’s type. Objects of the same type share the same value of the object field.

amountobject
The amount in specified currency that will land in the FinancialAccount balance.

createdtimestamp
Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

descriptionstring
A freeform text field provided by user, containing metadata.

fromobject
A nested object containing information about the origin of the InboundTransfer.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

receipt_urlnullable string
A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

toobject
A nested object containing information about the destination of the InboundTransfer.

transfer_historyarray of objects
A list of history objects, representing changes in the state of the InboundTransfer.

Error Codes

400inbound_transfer_from_payment_method_type_unsupported

Returned when a valid, but unsupported PaymentMethod for InboundTransfers is provided.

400inbound_transfer_from_payment_method_unverified

Returned when a PaymentMethod that has not been verified, is provided.

400inbound_transfer_not_allowed

Returned if an InboundTransfer is not allowed for risk, legal, regulatory or other unforeseen reasons.

404inbound_transfer_from_payment_method_not_found

Returned when a PaymentMethod cannot be found.

404inbound_transfer_to_financial_account_not_found

Returned when a FinancialAccount cannot be found.

404not_found

The resource wasn’t found.

409idempotency_error

An idempotent retry occurred with different request parameters.

POST /v2/money_management/inbound_transfers

Server-side language

curl -X POST https://api.stripe.com/v2/money_management/inbound_transfers \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview" \
  --json '{
    "description": "April Payouts",
    "from": {
        "payment_method": "usba_test_61P22mHGGhTkqVEx416Nr2cJ8cSQabKn4q38nZ59E7ea"
    },
    "to": {
        "financial_account": "fa_test_65Nyg0pdsXOSN32kkjg16Nr2cJ8cSQabKn4q38nZ59E50y",
        "currency": "usd"
    },
    "amount": {
        "value": 101,
        "currency": "usd"
    }
  }'

Response

{
  "id": "ibt_test_61Q58XwKMHh5ha3MI16Nr2cJ8cSQabKn4q38nZ59E6yO",
  "object": "v2.money_management.inbound_transfer",
  "amount": {
    "value": 101,
    "currency": "usd"
  },
  "created": "2024-03-18T18:07:12.619131Z",
  "description": "April Payouts",
  "from": {
    "debited": {
      "value": 101,
      "currency": "usd"
    },
    "payment_method": {
      "type": "payment_methods.us_bank_account",
      "us_bank_account": "usba_test_61P22mHGGhTkqVEx416Nr2cJ8cSQabKn4q38nZ59E7ea"
    }
  },
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk5yMmNKOGNTUWFiS240cTM4blo1OUUohIbirwYyBvlQ2PtS3zpGlI2ZkpO8-dpYhb3KfWs1FlYI9eX2I94gJoeJHXOR0QwwesVCRnQwRgsUQqGFloqKV7McODKkoVKAMiuB5lD9htcDuxRtDA",
  "to": {
    "credited": {
      "value": 101,
      "currency": "usd"
    },
    "financial_account": "fa_test_65Nyg0pdsXOSN32kkjg16Nr2cJ8cSQabKn4q38nZ59E50y"
  },
  "transfer_history": [
    {
      "id": "ibthe_test_61Q58Xw5weaazmsWj16Nr2cJ8cSQabKn4q38nZ59E52W",
      "bank_debit_queued": {},
      "created": "2024-03-18T18:07:12.617Z",
      "effective_at": "2024-03-18T18:07:12.617Z",
      "level": "canonical",
      "type": "bank_debit_queued"
    },
    {
      "id": "ibthe_test_61Q58Y2iAWn3U9kNW16Nr2cJ8cSQabKn4q38nZ59EXzc",
      "bank_debit_processing": {},
      "created": "2024-03-18T18:07:18.403Z",
      "effective_at": "2024-03-18T18:07:18.403Z",
      "level": "canonical",
      "type": "bank_debit_processing"
    },
    {
      "id": "ibthe_test_61Q58Y7wNh292msCP16Nr2cJ8cSQabKn4q38nZ59EPz6",
      "bank_debit_succeeded": {},
      "created": "2024-03-18T18:07:23.103Z",
      "effective_at": "2024-03-18T18:07:23.103Z",
      "level": "canonical",
      "type": "bank_debit_succeeded"
    }
  ]
}

Retrieve an InboundTransfer object v2

Learn more about calling API v2 endpoints.

Retrieve an InboundTransfer by ID.

Parameters

idstringRequired
The ID of the InboundTransfer to retrieve.

Returns

Response attributes

idstring
Unique identifier for the InboundTransfer.

objectstring, value is "v2.money_management.inbound_transfer"
String representing the object’s type. Objects of the same type share the same value of the object field.

amountobject
The amount in specified currency that will land in the FinancialAccount balance.

createdtimestamp
Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

descriptionstring
A freeform text field provided by user, containing metadata.

fromobject
A nested object containing information about the origin of the InboundTransfer.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

receipt_urlnullable string
A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

toobject
A nested object containing information about the destination of the InboundTransfer.

transfer_historyarray of objects
A list of history objects, representing changes in the state of the InboundTransfer.

Error Codes

404not_found

The resource wasn’t found.

GET /v2/money_management/inbound_transfers/:id

Server-side language

curl https://api.stripe.com/v2/money_management/inbound_transfers/ibt_test_61Q58XwKMHh5ha3MI16Nr2cJ8cSQabKn4q38nZ59E6yO \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview"

Response

{
  "id": "ibt_test_61Q58XwKMHh5ha3MI16Nr2cJ8cSQabKn4q38nZ59E6yO",
  "object": "v2.money_management.inbound_transfer",
  "amount": {
    "value": 101,
    "currency": "usd"
  },
  "created": "2024-03-18T18:07:12.619131Z",
  "description": "earnings",
  "from": {
    "debited": {
      "value": 101,
      "currency": "usd"
    },
    "payment_method": {
      "type": "payment_methods.us_bank_account",
      "us_bank_account": "usba_test_61P22mHGGhTkqVEx416Nr2cJ8cSQabKn4q38nZ59E7ea"
    }
  },
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk5yMmNKOGNTUWFiS240cTM4blo1OUUohIbirwYyBvlQ2PtS3zpGlI2ZkpO8-dpYhb3KfWs1FlYI9eX2I94gJoeJHXOR0QwwesVCRnQwRgsUQqGFloqKV7McODKkoVKAMiuB5lD9htcDuxRtDA",
  "to": {
    "credited": {
      "value": 101,
      "currency": "usd"
    },
    "financial_account": "fa_test_65Nyg0pdsXOSN32kkjg16Nr2cJ8cSQabKn4q38nZ59E50y"
  },
  "transfer_history": [
    {
      "id": "ibthe_test_61Q58Xw5weaazmsWj16Nr2cJ8cSQabKn4q38nZ59E52W",
      "bank_debit_queued": {},
      "created": "2024-03-18T18:07:12.617Z",
      "effective_at": "2024-03-18T18:07:12.617Z",
      "level": "canonical",
      "type": "bank_debit_queued"
    },
    {
      "id": "ibthe_test_61Q58Y2iAWn3U9kNW16Nr2cJ8cSQabKn4q38nZ59EXzc",
      "bank_debit_processing": {},
      "created": "2024-03-18T18:07:18.403Z",
      "effective_at": "2024-03-18T18:07:18.403Z",
      "level": "canonical",
      "type": "bank_debit_processing"
    },
    {
      "id": "ibthe_test_61Q58Y7wNh292msCP16Nr2cJ8cSQabKn4q38nZ59EPz6",
      "bank_debit_succeeded": {},
      "created": "2024-03-18T18:07:23.103Z",
      "effective_at": "2024-03-18T18:07:23.103Z",
      "level": "canonical",
      "type": "bank_debit_succeeded"
    }
  ]
}

List all InboundTransfer objects v2

Learn more about calling API v2 endpoints.

Retrieves a list of InboundTransfers.

Parameters

createdtimestamp
Filter for objects created at the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

created_gttimestamp
Filter for objects created after the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

created_gtetimestamp
Filter for objects created on or after the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

created_lttimestamp
Filter for objects created before the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

created_ltetimestamp
Filter for objects created on or before the specified timestamp. Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.

limitinteger
The page limit.

pagestring
The page token.

Returns

Response attributes

dataarray of objects
The list of retrieved InboundTransfers.

next_page_urlnullable string
The next page url.

previous_page_urlnullable string
The previous page url.

Error Codes

404not_found

The resource wasn’t found.

GET /v2/money_management/inbound_transfers

Server-side language

curl -G https://api.stripe.com/v2/money_management/inbound_transfers \
  -H "Authorization: Bearer {{YOUR_API_KEY}}{{YOUR_API_KEY}}" \
  -H "Stripe-Version: 2025-04-30.preview" \
  -d limit=10

Response

{
  "data": [
    {
      "id": "ibt_test_61Ptdb61ySxOc4VMe16Nr2cJ8cSQabKn4q38nZ59EFcu",
      "object": "v2.money_management.inbound_transfer",
      "amount": {
        "value": 101,
        "currency": "usd"
      },
      "created": "2024-02-16T00:50:56.154471Z",
      "description": "",
      "from": {
        "debited": {
          "value": 101,
          "currency": "usd"
        },
        "payment_method": {
          "type": "payment_methods.us_bank_account",
          "us_bank_account": "usba_test_61P22mHGGhTkqVEx416Nr2cJ8cSQabKn4q38nZ59E7ea"
        }
      },
      "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk5yMmNKOGNTUWFiS240cTM4blo1OUUol4nirwYyBi-u70wgczpGlOv1PxesNa_x3-CmgvINy-9SzW6t1qMJGYUWQroQuUT_snt4LMqOIkQvte7D5iA0Qw-WRpFG8guSrfoma4148OeCAkNfzA",
      "to": {
        "credited": {
          "value": 101,
          "currency": "usd"
        },
        "financial_account": "fa_test_65Nyg0pdsXOSN32kkjg16Nr2cJ8cSQabKn4q38nZ59E50y"
      },
      "transfer_history": [
        {
          "id": "ibthe_test_61Ptdb6GDbDR56tXt16Nr2cJ8cSQabKn4q38nZ59ERvE",
          "bank_debit_queued": {},
          "created": "2024-02-16T00:50:56.152Z",
          "effective_at": "2024-02-16T00:50:56.152Z",
          "level": "canonical",
          "type": "bank_debit_queued"
        },
        {
          "id": "ibthe_test_61PtdbBmQQgOkrPbe16Nr2cJ8cSQabKn4q38nZ59EPuS",
          "bank_debit_processing": {},
          "created": "2024-02-16T00:51:01.925Z",
          "effective_at": "2024-02-16T00:51:01.925Z",
          "level": "canonical",
          "type": "bank_debit_processing"
        },
        {
          "id": "ibthe_test_61PtdbG9ChR1FDFwE16Nr2cJ8cSQabKn4q38nZ59EF9k",
          "bank_debit_succeeded": {},
          "created": "2024-02-16T00:51:06.618Z",
          "effective_at": "2024-02-16T00:51:06.618Z",
          "level": "canonical",
          "type": "bank_debit_succeeded"
        }
      ]
    },
    {
      "id": "ibt_test_61PtdOWOXFYYaDZpW16Nr2cJ8cSQabKn4q38nZ59E8kK",
      "object": "v2.money_management.inbound_transfer",
      "amount": {
        "value": 101,
        "currency": "usd"
      },
      "created": "2024-02-16T00:37:56.172040Z",
      "description": "",
      "from": {
        "debited": {
          "value": 101,
          "currency": "usd"
        },
        "payment_method": {
          "type": "payment_methods.us_bank_account",
          "us_bank_account": "usba_test_61P22mHGGhTkqVEx416Nr2cJ8cSQabKn4q38nZ59E7ea"
        }
      },
      "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMQARojCiF3a3NwX3Rlc3RfNk5yMmNKOGNTUWFiS240cTM4blo1OUUol4nirwYyBn-td8zMvTpGlJJ6_jW5z0Py6wXu2fI_jabxid1HroW6SuJy8uZDBuDXWQ-KhDLUiZUWOj_70AmiU2f06Lv6X1nWoe1b0XKsoJ5qftnenw",
      "to": {
        "credited": {
          "value": 101,
          "currency": "usd"
        },
        "financial_account": "fa_test_65Nyg0pdsXOSN32kkjg16Nr2cJ8cSQabKn4q38nZ59E50y"
      },
      "transfer_history": [
        {
          "id": "ibthe_test_61PtdOWQxDcYFqYsT16Nr2cJ8cSQabKn4q38nZ59ELZg",
          "bank_debit_queued": {},
          "created": "2024-02-16T00:37:56.170Z",
          "effective_at": "2024-02-16T00:37:56.170Z",
          "level": "canonical",
          "type": "bank_debit_queued"
        },
        {
          "id": "ibthe_test_61PtdOc8HI8HBvaLd16Nr2cJ8cSQabKn4q38nZ59EG3E",
          "bank_debit_processing": {},
          "created": "2024-02-16T00:38:02.143Z",
          "effective_at": "2024-02-16T00:38:02.143Z",
          "level": "canonical",
          "type": "bank_debit_processing"
        },
        {
          "id": "ibthe_test_61PtdOgzFEOhgtcUu16Nr2cJ8cSQabKn4q38nZ59EWw4",
          "bank_debit_succeeded": {},
          "created": "2024-02-16T00:38:06.724Z",
          "effective_at": "2024-02-16T00:38:06.724Z",
          "level": "canonical",
          "type": "bank_debit_succeeded"
        }
      ]
    }
  ],
  "next_page_url": "0X41472HF7187kV7kb7gi6L83Hc7UP3Xl5o57k34gS6oy3bl3HC5Du3M34wS6c75Q16Xr7L27XP3l060T3oT3TY5Gs2wX3cf7wD3cV3Pv7t23ob3HD5sD5Lg3193kn4tF7bp85D3cl5Y16Lc4l57g16sM5wX44e0Tq1oI3D03TR3D030a3YC3LF3sL3Te3Tb34m3LI3Xi3De",
  "previous_page_url": "0X31472HF7187kV7kb7gi6L83Hc7ka6XW3IH5Ye5Hn3U659Z3HC5Du3M34wS6c75Q16Xr7L27XP3l060T3oT4gd7nm2wX3cf7wD3cV3Pv7t23ob3HD5sD5Lg3193kn4tF7bp85D3cl5Y16Lc4l57g16sM5wX44e0Tq1oI3D03TR3D030b3cK3Cy3sL3D83Xi34j3Xg3Tb3Hm"
}

InboundTransfer event types v2

Learn more about calling API v2 endpoints.

This is a list of all public thin events we currently send for updates to InboundTransfer, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

v2.money_management.inbound_transfer.available

Occurs when an InboundTransfer's funds are made available.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.inbound_transfer.available"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.inbound_transfer.bank_debit_failed

Occurs when an InboundTransfer fails.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.inbound_transfer.bank_debit_failed"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.inbound_transfer.bank_debit_processing

Occurs when an InboundTransfer starts processing.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.inbound_transfer.bank_debit_processing"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.inbound_transfer.bank_debit_queued

Occurs when an InboundTransfer is queued.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.inbound_transfer.bank_debit_queued"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.inbound_transfer.bank_debit_returned

Occurs when an InboundTransfer is returned.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.inbound_transfer.bank_debit_returned"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.money_management.inbound_transfer.bank_debit_succeeded

Occurs when an InboundTransfer succeeds.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.money_management.inbound_transfer.bank_debit_succeeded"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "context": null,
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
  "livemode": true,
  "object": "v2.core.event",
  "reason": {
    "type": "request",
    "request": {
      "id": "req_v24sUK2aV6o01RdVU",
      "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
    }
  },
  "related_object": {
    "id": "ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
    "type": "v2.money_management.inbound_transfer",
    "url": "/v2/money_management/inbound_transfers/ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
  },
  "type": "v2.money_management.inbound_transfer.bank_debit_succeeded"
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "context": null,
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
  "livemode": true,
  "object": "v2.core.event",
  "reason": {
    "type": "request",
    "request": {
      "id": "req_v24sUK2aV6o01RdVU",
      "idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
    }
  },
  "related_object": {
    "id": "ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
    "type": "v2.money_management.inbound_transfer",
    "url": "/v2/money_management/inbound_transfers/ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
  },
  "type": "v2.money_management.inbound_transfer.bank_debit_succeeded",
  "changes": {},
  "data": {}
}

The InboundTransfer object

Attributes

idstring

objectstring, value is "v2.money_management.inbound_transfer"

amountobject

createdtimestamp

descriptionstring

fromobject

livemodeboolean

receipt_urlnullable string

toobject

transfer_historyarray of objects

Create an InboundTransfer object v2

Parameters

amountobjectRequired

fromobjectRequired

toobjectRequired

descriptionstring

Returns

Response attributes

idstring

objectstring, value is "v2.money_management.inbound_transfer"

amountobject

createdtimestamp

descriptionstring

fromobject

livemodeboolean

receipt_urlnullable string

toobject

transfer_historyarray of objects

Retrieve an InboundTransfer object v2

Parameters

idstringRequired

Returns

Response attributes

idstring

objectstring, value is "v2.money_management.inbound_transfer"

amountobject

createdtimestamp

descriptionstring

fromobject

livemodeboolean

receipt_urlnullable string

toobject

transfer_historyarray of objects

List all InboundTransfer objects v2

Parameters

createdtimestamp

created_gttimestamp

created_gtetimestamp

created_lttimestamp

created_ltetimestamp

limitinteger

pagestring

Returns

Response attributes

dataarray of objects

next_page_urlnullable string

previous_page_urlnullable string

InboundTransfer event types v2

Event types

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.money_management.inbound_transfer.available"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object