From f49c9571e43aab020d08ae57fc7b5b590f65e6de Mon Sep 17 00:00:00 2001
From: "stripe-openapi[bot]"
<105521251+stripe-openapi[bot]@users.noreply.github.com>
Date: Mon, 6 May 2024 20:15:13 +0000
Subject: [PATCH] OpenAPI Update (#797)
Update OpenAPI for dce6c4bbd3cf10a680328da255baf93badcf33f1
Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
---
embedded/openapi/spec3.beta.sdk.json | 454 +++++++++++++++++++++++++++
embedded/openapi/spec3.json | 392 +++++++++++++++++++++++
2 files changed, 846 insertions(+)
diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json
index f20bf0ca..b808e1e8 100644
--- a/embedded/openapi/spec3.beta.sdk.json
+++ b/embedded/openapi/spec3.beta.sdk.json
@@ -16303,12 +16303,14 @@
"treasury.outbound_payment.failed",
"treasury.outbound_payment.posted",
"treasury.outbound_payment.returned",
+ "treasury.outbound_payment.tracking_details_updated",
"treasury.outbound_transfer.canceled",
"treasury.outbound_transfer.created",
"treasury.outbound_transfer.expected_arrival_date_updated",
"treasury.outbound_transfer.failed",
"treasury.outbound_transfer.posted",
"treasury.outbound_transfer.returned",
+ "treasury.outbound_transfer.tracking_details_updated",
"treasury.received_credit.created",
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
@@ -68208,6 +68210,15 @@
"status_transitions": {
"$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"
},
+ "tracking_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"
+ }
+ ],
+ "description": "Details about network-specific tracking information if available.",
+ "nullable": true
+ },
"transaction": {
"anyOf": [
{
@@ -68258,6 +68269,7 @@
"end_user_details",
"returned_details",
"status_transitions",
+ "tracking_details",
"transaction"
],
"x-resourceId": "treasury.outbound_payment",
@@ -68276,6 +68288,13 @@
"operation": "get",
"path": "/v1/treasury/outbound_payments/{id}"
},
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/test_helpers/treasury/outbound_payments/{id}"
+ },
{
"method_name": "fail",
"method_on": "service",
@@ -68414,6 +68433,22 @@
"type": "treasury.outbound_payment.returned"
}
},
+ "treasury.outbound_payment.tracking_details_updated": {
+ "description": "Occurs whenever tracking_details on an OutboundPayment is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.tracking_details_updated"
+ }
+ },
"treasury.outbound_transfer": {
"description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.",
"properties": {
@@ -68526,6 +68561,15 @@
"status_transitions": {
"$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions"
},
+ "tracking_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"
+ }
+ ],
+ "description": "Details about network-specific tracking information if available.",
+ "nullable": true
+ },
"transaction": {
"anyOf": [
{
@@ -68574,6 +68618,7 @@
"network_details",
"returned_details",
"status_transitions",
+ "tracking_details",
"transaction"
],
"x-resourceId": "treasury.outbound_transfer",
@@ -68592,6 +68637,13 @@
"operation": "get",
"path": "/v1/treasury/outbound_transfers/{outbound_transfer}"
},
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}"
+ },
{
"method_name": "fail",
"method_on": "service",
@@ -68730,6 +68782,22 @@
"type": "treasury.outbound_transfer.returned"
}
},
+ "treasury.outbound_transfer.tracking_details_updated": {
+ "description": "Occurs whenever tracking_details on an OutboundTransfer is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.tracking_details_updated"
+ }
+ },
"treasury.received_credit": {
"description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.",
"properties": {
@@ -70022,6 +70090,22 @@
"in_package": ""
}
},
+ "treasury_outbound_payments_resource_ach_tracking_details": {
+ "description": "",
+ "properties": {
+ "trace_id": {
+ "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
"treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": {
"description": "",
"properties": {
@@ -70086,6 +70170,34 @@
"in_package": ""
}
},
+ "treasury_outbound_payments_resource_outbound_payment_resource_tracking_details": {
+ "description": "",
+ "properties": {
+ "ach": {
+ "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details"
+ },
+ "type": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "ach",
+ "us_domestic_wire"
+ ]
+ },
"treasury_outbound_payments_resource_returned_status": {
"description": "",
"properties": {
@@ -70135,6 +70247,29 @@
"transaction"
]
},
+ "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": {
+ "description": "",
+ "properties": {
+ "imad": {
+ "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "imad",
+ "omad"
+ ],
+ "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
"treasury_outbound_transfers_resource_ach_network_details": {
"description": "",
"properties": {
@@ -70152,6 +70287,22 @@
"type": "object",
"x-expandableFields": []
},
+ "treasury_outbound_transfers_resource_ach_tracking_details": {
+ "description": "",
+ "properties": {
+ "trace_id": {
+ "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "TreasuryOutboundTransfersResourceACHTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
"treasury_outbound_transfers_resource_network_details": {
"description": "",
"properties": {
@@ -70185,6 +70336,34 @@
"in_package": ""
}
},
+ "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": {
+ "description": "",
+ "properties": {
+ "ach": {
+ "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details"
+ },
+ "type": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "ach",
+ "us_domestic_wire"
+ ]
+ },
"treasury_outbound_transfers_resource_returned_details": {
"description": "",
"properties": {
@@ -70280,6 +70459,29 @@
"in_package": ""
}
},
+ "treasury_outbound_transfers_resource_us_domestic_wire_tracking_details": {
+ "description": "",
+ "properties": {
+ "imad": {
+ "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "imad",
+ "omad"
+ ],
+ "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
"treasury_received_credits_resource_ach_network_details": {
"description": "",
"properties": {
@@ -197405,6 +197607,130 @@
}
}
},
+ "/v1/test_helpers/treasury/outbound_payments/{id}": {
+ "post": {
+ "description": "
Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled
or failed
states.
",
+ "operationId": "PostTestHelpersTreasuryOutboundPaymentsId",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "tracking_details": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tracking_details": {
+ "description": "Details about network-specific tracking information.",
+ "properties": {
+ "ach": {
+ "description": "ACH network tracking details.",
+ "properties": {
+ "trace_id": {
+ "description": "ACH trace ID for funds sent over the `ach` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "ach_tracking_details_params",
+ "type": "object"
+ },
+ "type": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "description": "US domestic wire network tracking details.",
+ "properties": {
+ "imad": {
+ "description": "IMAD for funds sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "description": "OMAD for funds sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "us_domestic_wire_tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "tracking_details"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/test_helpers/treasury/outbound_payments/{id}/fail": {
"post": {
"description": "Transitions a test mode created OutboundPayment to the failed
status. The OutboundPayment must already be in the processing
state.
",
@@ -197633,6 +197959,130 @@
}
}
},
+ "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": {
+ "post": {
+ "description": "Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled
or failed
states.
",
+ "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "outbound_transfer",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "tracking_details": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tracking_details": {
+ "description": "Details about network-specific tracking information.",
+ "properties": {
+ "ach": {
+ "description": "ACH network tracking details.",
+ "properties": {
+ "trace_id": {
+ "description": "ACH trace ID for funds sent over the `ach` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "ach_tracking_details_params",
+ "type": "object"
+ },
+ "type": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "description": "US domestic wire network tracking details.",
+ "properties": {
+ "imad": {
+ "description": "IMAD for funds sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "description": "OMAD for funds sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "us_domestic_wire_tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "tracking_details"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": {
"post": {
"description": "Transitions a test mode created OutboundTransfer to the failed
status. The OutboundTransfer must already be in the processing
state.
",
@@ -205937,12 +206387,14 @@
"treasury.outbound_payment.failed",
"treasury.outbound_payment.posted",
"treasury.outbound_payment.returned",
+ "treasury.outbound_payment.tracking_details_updated",
"treasury.outbound_transfer.canceled",
"treasury.outbound_transfer.created",
"treasury.outbound_transfer.expected_arrival_date_updated",
"treasury.outbound_transfer.failed",
"treasury.outbound_transfer.posted",
"treasury.outbound_transfer.returned",
+ "treasury.outbound_transfer.tracking_details_updated",
"treasury.received_credit.created",
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
@@ -206444,12 +206896,14 @@
"treasury.outbound_payment.failed",
"treasury.outbound_payment.posted",
"treasury.outbound_payment.returned",
+ "treasury.outbound_payment.tracking_details_updated",
"treasury.outbound_transfer.canceled",
"treasury.outbound_transfer.created",
"treasury.outbound_transfer.expected_arrival_date_updated",
"treasury.outbound_transfer.failed",
"treasury.outbound_transfer.posted",
"treasury.outbound_transfer.returned",
+ "treasury.outbound_transfer.tracking_details_updated",
"treasury.received_credit.created",
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json
index 8fb7037f..dc60a19a 100644
--- a/embedded/openapi/spec3.json
+++ b/embedded/openapi/spec3.json
@@ -47294,6 +47294,15 @@
"status_transitions": {
"$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"
},
+ "tracking_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"
+ }
+ ],
+ "description": "Details about network-specific tracking information if available.",
+ "nullable": true
+ },
"transaction": {
"anyOf": [
{
@@ -47337,6 +47346,7 @@
"end_user_details",
"returned_details",
"status_transitions",
+ "tracking_details",
"transaction"
],
"x-resourceId": "treasury.outbound_payment"
@@ -47444,6 +47454,15 @@
"status_transitions": {
"$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions"
},
+ "tracking_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"
+ }
+ ],
+ "description": "Details about network-specific tracking information if available.",
+ "nullable": true
+ },
"transaction": {
"anyOf": [
{
@@ -47487,6 +47506,7 @@
"destination_payment_method_details",
"returned_details",
"status_transitions",
+ "tracking_details",
"transaction"
],
"x-resourceId": "treasury.outbound_transfer"
@@ -48518,6 +48538,22 @@
"type": "object",
"x-expandableFields": []
},
+ "treasury_outbound_payments_resource_ach_tracking_details": {
+ "description": "",
+ "properties": {
+ "trace_id": {
+ "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
"treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": {
"description": "",
"properties": {
@@ -48571,6 +48607,34 @@
"type": "object",
"x-expandableFields": []
},
+ "treasury_outbound_payments_resource_outbound_payment_resource_tracking_details": {
+ "description": "",
+ "properties": {
+ "ach": {
+ "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details"
+ },
+ "type": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "ach",
+ "us_domestic_wire"
+ ]
+ },
"treasury_outbound_payments_resource_returned_status": {
"description": "",
"properties": {
@@ -48620,6 +48684,72 @@
"transaction"
]
},
+ "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": {
+ "description": "",
+ "properties": {
+ "imad": {
+ "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "imad"
+ ],
+ "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "treasury_outbound_transfers_resource_ach_tracking_details": {
+ "description": "",
+ "properties": {
+ "trace_id": {
+ "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "TreasuryOutboundTransfersResourceACHTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": {
+ "description": "",
+ "properties": {
+ "ach": {
+ "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details"
+ },
+ "type": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "ach",
+ "us_domestic_wire"
+ ]
+ },
"treasury_outbound_transfers_resource_returned_details": {
"description": "",
"properties": {
@@ -48701,6 +48831,28 @@
"type": "object",
"x-expandableFields": []
},
+ "treasury_outbound_transfers_resource_us_domestic_wire_tracking_details": {
+ "description": "",
+ "properties": {
+ "imad": {
+ "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "imad"
+ ],
+ "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails",
+ "type": "object",
+ "x-expandableFields": []
+ },
"treasury_received_credits_resource_linked_flows": {
"description": "",
"properties": {
@@ -150659,6 +150811,124 @@
}
}
},
+ "/v1/test_helpers/treasury/outbound_payments/{id}": {
+ "post": {
+ "description": "Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled
or failed
states.
",
+ "operationId": "PostTestHelpersTreasuryOutboundPaymentsId",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "tracking_details": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tracking_details": {
+ "description": "Details about network-specific tracking information.",
+ "properties": {
+ "ach": {
+ "properties": {
+ "trace_id": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "ach_tracking_details_params",
+ "type": "object"
+ },
+ "type": {
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "properties": {
+ "imad": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "us_domestic_wire_tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "tracking_details"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/test_helpers/treasury/outbound_payments/{id}/fail": {
"post": {
"description": "Transitions a test mode created OutboundPayment to the failed
status. The OutboundPayment must already be in the processing
state.
",
@@ -150886,6 +151156,124 @@
}
}
},
+ "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": {
+ "post": {
+ "description": "Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled
or failed
states.
",
+ "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "outbound_transfer",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "tracking_details": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tracking_details": {
+ "description": "Details about network-specific tracking information.",
+ "properties": {
+ "ach": {
+ "properties": {
+ "trace_id": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "trace_id"
+ ],
+ "title": "ach_tracking_details_params",
+ "type": "object"
+ },
+ "type": {
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "us_domestic_wire": {
+ "properties": {
+ "imad": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "omad": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "us_domestic_wire_tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "tracking_details_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "tracking_details"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": {
"post": {
"description": "Transitions a test mode created OutboundTransfer to the failed
status. The OutboundTransfer must already be in the processing
state.
",
@@ -158706,12 +159094,14 @@
"treasury.outbound_payment.failed",
"treasury.outbound_payment.posted",
"treasury.outbound_payment.returned",
+ "treasury.outbound_payment.tracking_details_updated",
"treasury.outbound_transfer.canceled",
"treasury.outbound_transfer.created",
"treasury.outbound_transfer.expected_arrival_date_updated",
"treasury.outbound_transfer.failed",
"treasury.outbound_transfer.posted",
"treasury.outbound_transfer.returned",
+ "treasury.outbound_transfer.tracking_details_updated",
"treasury.received_credit.created",
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
@@ -159184,12 +159574,14 @@
"treasury.outbound_payment.failed",
"treasury.outbound_payment.posted",
"treasury.outbound_payment.returned",
+ "treasury.outbound_payment.tracking_details_updated",
"treasury.outbound_transfer.canceled",
"treasury.outbound_transfer.created",
"treasury.outbound_transfer.expected_arrival_date_updated",
"treasury.outbound_transfer.failed",
"treasury.outbound_transfer.posted",
"treasury.outbound_transfer.returned",
+ "treasury.outbound_transfer.tracking_details_updated",
"treasury.received_credit.created",
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",