Test mode: Fail an InboundTransfer Test helper

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

Parameters

  • failure_detailsobject

    Details about a failed InboundTransfer.

Returns

Returns the InboundTransfer object in the returned state. Returns an error if the InboundTransfer has already failed or cannot be failed.

POST /v1/test_helpers/treasury/inbound_transfers/:id/fail
curl https://api.stripe.com/v1/test_helpers/treasury/inbound_transfers/ibt_1MtaDN2eZvKYlo2CxcxF1Qwi/fail \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d "failure_details[code]"=insufficient_funds
Response
{
"id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi",
"object": "treasury.inbound_transfer",
"amount": 10000,
"cancelable": true,
"created": 1680716025,
"currency": "usd",
"description": "InboundTransfer from my external bank account",
"failure_details": {
"code": "insufficient_funds"
},
"financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4",
"hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgZ09q__wJA6NpPUfXQX0PUpgdTTpcHXdViKIK3-mEuzKM_CrltWFzRyKdq8OhPb6676H32JwPak4k0jonMLYA",
"linked_flows": {
"received_debit": null
},
"livemode": false,
"metadata": {},
"origin_payment_method": "pm_1MtaDN2eZvKYlo2CObQW5Wkv",
"origin_payment_method_details": {
"billing_details": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Fake Street",
"line2": null,
"postal_code": "94102",
"state": "CA"
},
"email": null,
"name": "Jane Austen"
},
"type": "us_bank_account",
"us_bank_account": {
"account_holder_type": "company",
"account_type": "checking",
"bank_name": "STRIPE TEST BANK",
"fingerprint": "AP24Iso0btGp4N10",
"last4": "6789",
"network": "ach",
"routing_number": "110000000"
}
},
"returned": false,
"statement_descriptor": "transfer",
"status": "failed",
"status_transitions": {
"failed_at": 1680716025,
"succeeded_at": null
},
"transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa"
}

Test mode: Return an InboundTransfer Test helper

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

Parameters

No parameters.

Returns

Returns the InboundTransfer object with returned set to true. Returns an error if the InboundTransfer has already been returned or cannot be returned.

POST /v1/test_helpers/treasury/inbound_transfers/:id/return
curl -X POST https://api.stripe.com/v1/test_helpers/treasury/inbound_transfers/ibt_1MtaDN2eZvKYlo2CxcxF1Qwi/return \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi",
"object": "treasury.inbound_transfer",
"amount": 10000,
"cancelable": true,
"created": 1680716025,
"currency": "usd",
"description": "InboundTransfer from my external bank account",
"failure_details": null,
"financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4",
"hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgYvkdeXVp86NpNVlQmJPh28UZzYqO663FQJ4x3nf7tL4goXRt2IONIMvkuzcdxraW__iDMg9Uijq8tP1PcUbA",
"linked_flows": {
"received_debit": "rd_1MtaDN2eZvKYlo2ChwXbpRWa"
},
"livemode": false,
"metadata": {},
"origin_payment_method": "pm_1MtaDN2eZvKYlo2CObQW5Wkv",
"origin_payment_method_details": {
"billing_details": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Fake Street",
"line2": null,
"postal_code": "94102",
"state": "CA"
},
"email": null,
"name": "Jane Austen"
},
"type": "us_bank_account",
"us_bank_account": {
"account_holder_type": "company",
"account_type": "checking",
"bank_name": "STRIPE TEST BANK",
"fingerprint": "AP24Iso0btGp4N10",
"last4": "6789",
"network": "ach",
"routing_number": "110000000"
}
},
"returned": true,
"statement_descriptor": "transfer",
"status": "succeeded",
"status_transitions": {
"failed_at": null,
"succeeded_at": 1680716025
},
"transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa"
}

Test mode: Succeed an InboundTransfer Test helper

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

Parameters

No parameters.

Returns

Returns the InboundTransfer object in the succeeded state. Returns an error if the InboundTransfer has already succeeded or cannot be succeeded.

POST /v1/test_helpers/treasury/inbound_transfers/:id/succeed
curl -X POST https://api.stripe.com/v1/test_helpers/treasury/inbound_transfers/ibt_1MtaDN2eZvKYlo2CxcxF1Qwi/succeed \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi",
"object": "treasury.inbound_transfer",
"amount": 10000,
"cancelable": true,
"created": 1680716025,
"currency": "usd",
"description": "InboundTransfer from my external bank account",
"failure_details": null,
"financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4",
"hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgYVxjWLYpw6NpP6LLdBjWjsgc_5Q68S_eJDtpmsSgc_rHslxhpX2qqP0Xqb3fb3uLR2h-INgqgg7E81-mu1FQ",
"linked_flows": {
"received_debit": null
},
"livemode": false,
"metadata": {},
"origin_payment_method": "pm_1MtaDN2eZvKYlo2CObQW5Wkv",
"origin_payment_method_details": {
"billing_details": {
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Fake Street",
"line2": null,
"postal_code": "94102",
"state": "CA"
},
"email": null,
"name": "Jane Austen"
},
"type": "us_bank_account",
"us_bank_account": {
"account_holder_type": "company",
"account_type": "checking",
"bank_name": "STRIPE TEST BANK",
"fingerprint": "AP24Iso0btGp4N10",
"last4": "6789",
"network": "ach",
"routing_number": "110000000"
}
},
"returned": false,
"statement_descriptor": "transfer",
"status": "succeeded",
"status_transitions": {
"failed_at": null,
"succeeded_at": 1680716025
},
"transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa"
}

Received Credits 

ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.

Received Debits 

ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.