Test mode: Return an OutboundPayment Test helper

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

Parameters

  • returned_detailsobject

    Optional hash to set the return code.

Returns

Returns the OutboundPayment object in the returned state. Returns an error if the OutboundPayment has already been returned or cannot be returned.

POST /v1/test_helpers/treasury/outbound_payments/:id/return
curl -X POST https://api.stripe.com/v1/test_helpers/treasury/outbound_payments/obp_1MtaD72eZvKYlo2C36lgqC6Y/return \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "obp_1MtaD72eZvKYlo2C36lgqC6Y",
"object": "treasury.outbound_payment",
"amount": 10000,
"cancelable": false,
"created": 1680716009,
"currency": "usd",
"customer": null,
"description": "OutboundPayment to a 3rd party",
"destination_payment_method": null,
"destination_payment_method_details": {
"type": "us_bank_account",
"destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc"
},
"end_user_details": {
"ip_address": null,
"present": false
},
"expected_arrival_date": 1680716009,
"financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI",
"hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgYhogtESYQ6NZMO6Vt0EC3mum1Ote762Q9ymvgfrijWXRfgVjJ5BoXVxeND-NunsJmjcHhb2F_4bmtHHWur",
"livemode": false,
"metadata": {},
"returned_details": {
"code": "account_closed",
"transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"
},
"statement_descriptor": "payment",
"status": "returned",
"status_transitions": {
"failed_at": null,
"posted_at": 1680716010,
"returned_at": 1680716011,
"canceled_at": null
},
"transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"
}

Test mode: Update an OutboundPayment Test helper

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

Parameters

  • tracking_detailsobjectRequired

    Details about network-specific tracking information.

Returns

Returns the OutboundPayment object with the updated tracking details. Returns an error if the OutboundPayment is in an invalid state or if tracking_details has already been set.

POST /v1/test_helpers/treasury/outbound_payments/:id
curl https://api.stripe.com/v1/test_helpers/treasury/outbound_payments/obp_1MtaD72eZvKYlo2C36lgqC6Y \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d "tracking_details[type]"=ach \
-d "tracking_details[ach][trace_id]"=841042400123450
Response
{
"id": "obp_1MtaD72eZvKYlo2C36lgqC6Y",
"object": "treasury.outbound_payment",
"amount": 10000,
"cancelable": false,
"created": 1680716009,
"currency": "usd",
"customer": null,
"description": "OutboundPayment to a 3rd party",
"destination_payment_method": null,
"destination_payment_method_details": {
"type": "us_bank_account",
"destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc"
},
"end_user_details": {
"ip_address": null,
"present": false
},
"expected_arrival_date": 1680716009,
"financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI",
"hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgawWNwbI_w6NZNOI4y6vNpfIP-oQAT5mkBRbOHJN1f08r7jF-UumeywdupuJr7P2cxF8L5JRSVPMmttq_kA",
"livemode": false,
"metadata": {},
"returned_details": null,
"statement_descriptor": "payment",
"status": "posted",
"status_transitions": {
"failed_at": null,
"posted_at": 1680716010,
"returned_at": null,
"canceled_at": null
},
"tracking_details": {
"type": "ach",
"ach": {
"trace_id": "841042400123450"
}
},
"transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"
}

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.