{ "components": { "securitySchemes": { "apiKey": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" }, "basicAuth": { "scheme": "basic", "type": "http" } } }, "info": { "contact": { "email": "help@treasuryprime.com", "name": "Treasury Prime Support", "url": "https://support.treasuryprime.com" }, "summary": "Banking APIs", "termsOfService": "https://www.treasuryprime.com/policy/terms", "title": "Payments", "version": "1.18.691-g9292fa6c" }, "openapi": "3.1.0", "paths": { "/ach": { "get": { "parameters": [ { "description": "ID of the Account originating the transfer. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.", "in": "query", "name": "counterparty_id", "schema": { "type": "string" } }, { "description": "Direction of funds flow. One of `credit` (send money to your counterparty) or `debit` (receive money from your counterparty). Filterable.", "in": "query", "name": "direction", "schema": { "type": "string" } }, { "description": "The official effective date of the transaction, according to the ACH network. Filterable.", "in": "query", "name": "effective_date", "schema": { "type": "string" } }, { "description": "ID of your organization. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "Either `standard` or `sameday`. Specifies same-day or standard processing. Filterable.", "in": "query", "name": "service", "schema": { "type": "string" } }, { "description": "Current status of the ACH transfer. Read-only. Possible values: `pending`, `processing`, `sent`, `returned`, `canceled`, `error`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.", "in": "query", "name": "trace_number", "schema": { "type": "string" } }, { "in": "query", "name": "trace_suffix", "schema": { "type": "integer" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "amount": "100.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "description": null, "direction": "credit", "effective_date": "2017-11-03", "error": null, "id": "ach_1029384756", "originator_name": null, "scheduled_settlement": null, "sec_code": "ppd", "service": "standard", "status": "pending", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "addenda": { "description": "Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code `CCD` and `WEB`", "items": { "type": "string" }, "type": "array" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "batch_key": { "deprecated": true, "description": "Batch configuration to use for payment", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (send money to your counterparty) or `debit` (receive money from your counterparty). Filterable.", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network. Filterable.", "type": "string" }, "error": { "description": "If the ACH has been returned, this will contain the ACH return reason code for this entry. For example, \"R01\" would indicate insufficient funds", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "noc_change_code": { "description": "If a notice of change has been received for this ACH, this will contain the latest change code for this entry. For example, \"C02\" would indicate incorrect routing number", "type": "string" }, "noc_corrected_data": { "description": "If a notice of change has been received for this ACH, this will contain the latest corrected data for this entry. For example, this field could contain a corrected routing number", "type": "string" }, "org_id": { "description": "ID of your organization. Filterable.", "type": "string" }, "originator_name": { "description": "Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks", "type": "string" }, "scheduled_settlement": { "description": "A timestamp dictating the approximate time a debit ACH hold will be released, and the debit ACH will be considered settled. (only available when originating ACH on Treasury Prime ledger accounts)", "type": "string" }, "sec_code": { "description": "One of `ccd`, `ppd`, `tel`, `web`, `cie`, `arc`, or `boc`. Specifies the transfer type, according to the ACH network", "type": "string" }, "sec_details": { "description": "Optional supplemental fields required by certain SEC codes. Applicable when sec_code is one of: arc, boc, cie, tel, or web. The relevant sub-fields vary by sec_code — see the sec_details object definition for per-code field descriptions.", "properties": { "check_serial_number": { "description": "ARC, BOC: Check serial number of the supporting document for the entry.", "type": "string" }, "individual_id_number": { "description": "CIE: The accounting number by which the payor (the consumer) is known to the payee (receiver/biller). (max 22 characters)", "type": "string" }, "individual_name": { "description": "CIE: Typically the name of the payor on whose behalf the entry was transmitted. (max 15 characters)", "type": "string" }, "payment_type": { "description": "WEB,TEL: One of `recurring`, `single`, or `subsequent`. An Originator of a debit entry must ensure that each consumer debit authorization includes language clearly stating whether the authorization obtained from the Receiver is for a single entry, recurring entries, or one or more subsequent entries initiated under the terms of a standing authorization", "type": "string" } }, "type": "object" }, "service": { "description": "Either `standard` or `sameday`. Specifies same-day or standard processing. Filterable.", "type": "string" }, "status": { "description": "Current status of the ACH transfer. Read-only. Possible values: `pending`, `processing`, `sent`, `returned`, `canceled`, `error`. Filterable.", "type": "string" }, "trace_number": { "description": "15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.", "type": "string" }, "trace_suffix": { "type": "integer" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` ach elements, starting after the ach described by `page_cursor`. If no more achs are available, the resulting list will be empty." } }, "summary": "List ACH Transfers", "tags": [ "ACH" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "acct_1234567890", "amount": "100.00", "counterparty_id": "cp_0987654321", "direction": "credit", "sec_code": "ccd" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "addenda": { "description": "Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code `CCD` and `WEB`", "items": { "type": "string" }, "type": "array" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "batch_key": { "deprecated": true, "description": "Batch configuration to use for payment", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (send money to your counterparty) or `debit` (receive money from your counterparty). Filterable.", "type": "string" }, "originator_name": { "description": "Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks", "type": "string" }, "sec_code": { "description": "One of `ccd`, `ppd`, `tel`, `web`, `cie`, `arc`, or `boc`. Specifies the transfer type, according to the ACH network", "type": "string" }, "sec_details": { "description": "Optional supplemental fields required by certain SEC codes. Applicable when sec_code is one of: arc, boc, cie, tel, or web. The relevant sub-fields vary by sec_code — see the sec_details object definition for per-code field descriptions.", "properties": { "check_serial_number": { "description": "ARC, BOC: Check serial number of the supporting document for the entry.", "type": "string" }, "individual_id_number": { "description": "CIE: The accounting number by which the payor (the consumer) is known to the payee (receiver/biller). (max 22 characters)", "type": "string" }, "individual_name": { "description": "CIE: Typically the name of the payor on whose behalf the entry was transmitted. (max 15 characters)", "type": "string" }, "payment_type": { "description": "WEB,TEL: One of `recurring`, `single`, or `subsequent`. An Originator of a debit entry must ensure that each consumer debit authorization includes language clearly stating whether the authorization obtained from the Receiver is for a single entry, recurring entries, or one or more subsequent entries initiated under the terms of a standing authorization", "type": "string" } }, "type": "object" }, "service": { "description": "Either `standard` or `sameday`. Specifies same-day or standard processing. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "required": [ "amount", "service", "counterparty_id", "account_id", "id", "sec_code", "direction" ] } } }, "description": "The ach to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "100.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "description": null, "direction": "credit", "effective_date": "2017-11-03", "error": null, "id": "ach_1029384756", "originator_name": null, "scheduled_settlement": null, "sec_code": "ppd", "service": "standard", "status": "pending", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "addenda": { "description": "Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code `CCD` and `WEB`", "items": { "type": "string" }, "type": "array" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "batch_key": { "deprecated": true, "description": "Batch configuration to use for payment", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (send money to your counterparty) or `debit` (receive money from your counterparty). Filterable.", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network. Filterable.", "type": "string" }, "error": { "description": "If the ACH has been returned, this will contain the ACH return reason code for this entry. For example, \"R01\" would indicate insufficient funds", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "noc_change_code": { "description": "If a notice of change has been received for this ACH, this will contain the latest change code for this entry. For example, \"C02\" would indicate incorrect routing number", "type": "string" }, "noc_corrected_data": { "description": "If a notice of change has been received for this ACH, this will contain the latest corrected data for this entry. For example, this field could contain a corrected routing number", "type": "string" }, "org_id": { "description": "ID of your organization. Filterable.", "type": "string" }, "originator_name": { "description": "Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks", "type": "string" }, "scheduled_settlement": { "description": "A timestamp dictating the approximate time a debit ACH hold will be released, and the debit ACH will be considered settled. (only available when originating ACH on Treasury Prime ledger accounts)", "type": "string" }, "sec_code": { "description": "One of `ccd`, `ppd`, `tel`, `web`, `cie`, `arc`, or `boc`. Specifies the transfer type, according to the ACH network", "type": "string" }, "sec_details": { "description": "Optional supplemental fields required by certain SEC codes. Applicable when sec_code is one of: arc, boc, cie, tel, or web. The relevant sub-fields vary by sec_code — see the sec_details object definition for per-code field descriptions.", "properties": { "check_serial_number": { "description": "ARC, BOC: Check serial number of the supporting document for the entry.", "type": "string" }, "individual_id_number": { "description": "CIE: The accounting number by which the payor (the consumer) is known to the payee (receiver/biller). (max 22 characters)", "type": "string" }, "individual_name": { "description": "CIE: Typically the name of the payor on whose behalf the entry was transmitted. (max 15 characters)", "type": "string" }, "payment_type": { "description": "WEB,TEL: One of `recurring`, `single`, or `subsequent`. An Originator of a debit entry must ensure that each consumer debit authorization includes language clearly stating whether the authorization obtained from the Receiver is for a single entry, recurring entries, or one or more subsequent entries initiated under the terms of a standing authorization", "type": "string" } }, "type": "object" }, "service": { "description": "Either `standard` or `sameday`. Specifies same-day or standard processing. Filterable.", "type": "string" }, "status": { "description": "Current status of the ACH transfer. Read-only. Possible values: `pending`, `processing`, `sent`, `returned`, `canceled`, `error`. Filterable.", "type": "string" }, "trace_number": { "description": "15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.", "type": "string" }, "trace_suffix": { "type": "integer" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The ach created" }, "400": { "content": { "application/json": { "examples": { "insufficient-funds": { "summary": "Insufficient funds", "value": { "error": "ACH credit amount must not exceed the account's available balance." } }, "invalid-ach": { "summary": "Invalid ACH", "value": { "error": "You are not authorized to send ACH transfers in this direction. If you would like to request authorization, please contact support." } } } } }, "description": "Failed to create ach" }, "429": { "content": { "application/json": { "examples": { "ach-velocity": { "summary": "ACH velocity has been exceeded", "value": { "error": "You have reached your ACH 24 hour velocity limit. This limit exists for your safety. If you would like to raise (or lower) your limit, please contact support." } } } } }, "description": "Failed to create ach" } }, "summary": "Create an ACH", "tags": [ "ACH" ] } }, "/ach/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "100.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "description": null, "direction": "credit", "effective_date": "2017-11-03", "error": null, "id": "ach_1029384756", "originator_name": null, "scheduled_settlement": null, "sec_code": "ppd", "service": "standard", "status": "pending", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "addenda": { "description": "Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code `CCD` and `WEB`", "items": { "type": "string" }, "type": "array" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "batch_key": { "deprecated": true, "description": "Batch configuration to use for payment", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (send money to your counterparty) or `debit` (receive money from your counterparty). Filterable.", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network. Filterable.", "type": "string" }, "error": { "description": "If the ACH has been returned, this will contain the ACH return reason code for this entry. For example, \"R01\" would indicate insufficient funds", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "noc_change_code": { "description": "If a notice of change has been received for this ACH, this will contain the latest change code for this entry. For example, \"C02\" would indicate incorrect routing number", "type": "string" }, "noc_corrected_data": { "description": "If a notice of change has been received for this ACH, this will contain the latest corrected data for this entry. For example, this field could contain a corrected routing number", "type": "string" }, "org_id": { "description": "ID of your organization. Filterable.", "type": "string" }, "originator_name": { "description": "Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks", "type": "string" }, "scheduled_settlement": { "description": "A timestamp dictating the approximate time a debit ACH hold will be released, and the debit ACH will be considered settled. (only available when originating ACH on Treasury Prime ledger accounts)", "type": "string" }, "sec_code": { "description": "One of `ccd`, `ppd`, `tel`, `web`, `cie`, `arc`, or `boc`. Specifies the transfer type, according to the ACH network", "type": "string" }, "sec_details": { "description": "Optional supplemental fields required by certain SEC codes. Applicable when sec_code is one of: arc, boc, cie, tel, or web. The relevant sub-fields vary by sec_code — see the sec_details object definition for per-code field descriptions.", "properties": { "check_serial_number": { "description": "ARC, BOC: Check serial number of the supporting document for the entry.", "type": "string" }, "individual_id_number": { "description": "CIE: The accounting number by which the payor (the consumer) is known to the payee (receiver/biller). (max 22 characters)", "type": "string" }, "individual_name": { "description": "CIE: Typically the name of the payor on whose behalf the entry was transmitted. (max 15 characters)", "type": "string" }, "payment_type": { "description": "WEB,TEL: One of `recurring`, `single`, or `subsequent`. An Originator of a debit entry must ensure that each consumer debit authorization includes language clearly stating whether the authorization obtained from the Receiver is for a single entry, recurring entries, or one or more subsequent entries initiated under the terms of a standing authorization", "type": "string" } }, "type": "object" }, "service": { "description": "Either `standard` or `sameday`. Specifies same-day or standard processing. Filterable.", "type": "string" }, "status": { "description": "Current status of the ACH transfer. Read-only. Possible values: `pending`, `processing`, `sent`, `returned`, `canceled`, `error`. Filterable.", "type": "string" }, "trace_number": { "description": "15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.", "type": "string" }, "trace_suffix": { "type": "integer" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The ach" } }, "summary": "Fetch an ACH", "tags": [ "ACH" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Canceling an ACH", "value": { "status": "canceled" } } }, "schema": { "properties": { "status": { "description": "The new status of the ACH, one of: `canceled`", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The ach to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "100.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "description": null, "direction": "credit", "effective_date": "2017-11-03", "error": null, "id": "ach_1029384756", "originator_name": null, "scheduled_settlement": null, "sec_code": "ppd", "service": "standard", "status": "canceled", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "addenda": { "description": "Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code `CCD` and `WEB`", "items": { "type": "string" }, "type": "array" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "batch_key": { "deprecated": true, "description": "Batch configuration to use for payment", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (send money to your counterparty) or `debit` (receive money from your counterparty). Filterable.", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network. Filterable.", "type": "string" }, "error": { "description": "If the ACH has been returned, this will contain the ACH return reason code for this entry. For example, \"R01\" would indicate insufficient funds", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "noc_change_code": { "description": "If a notice of change has been received for this ACH, this will contain the latest change code for this entry. For example, \"C02\" would indicate incorrect routing number", "type": "string" }, "noc_corrected_data": { "description": "If a notice of change has been received for this ACH, this will contain the latest corrected data for this entry. For example, this field could contain a corrected routing number", "type": "string" }, "org_id": { "description": "ID of your organization. Filterable.", "type": "string" }, "originator_name": { "description": "Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks", "type": "string" }, "scheduled_settlement": { "description": "A timestamp dictating the approximate time a debit ACH hold will be released, and the debit ACH will be considered settled. (only available when originating ACH on Treasury Prime ledger accounts)", "type": "string" }, "sec_code": { "description": "One of `ccd`, `ppd`, `tel`, `web`, `cie`, `arc`, or `boc`. Specifies the transfer type, according to the ACH network", "type": "string" }, "sec_details": { "description": "Optional supplemental fields required by certain SEC codes. Applicable when sec_code is one of: arc, boc, cie, tel, or web. The relevant sub-fields vary by sec_code — see the sec_details object definition for per-code field descriptions.", "properties": { "check_serial_number": { "description": "ARC, BOC: Check serial number of the supporting document for the entry.", "type": "string" }, "individual_id_number": { "description": "CIE: The accounting number by which the payor (the consumer) is known to the payee (receiver/biller). (max 22 characters)", "type": "string" }, "individual_name": { "description": "CIE: Typically the name of the payor on whose behalf the entry was transmitted. (max 15 characters)", "type": "string" }, "payment_type": { "description": "WEB,TEL: One of `recurring`, `single`, or `subsequent`. An Originator of a debit entry must ensure that each consumer debit authorization includes language clearly stating whether the authorization obtained from the Receiver is for a single entry, recurring entries, or one or more subsequent entries initiated under the terms of a standing authorization", "type": "string" } }, "type": "object" }, "service": { "description": "Either `standard` or `sameday`. Specifies same-day or standard processing. Filterable.", "type": "string" }, "status": { "description": "Current status of the ACH transfer. Read-only. Possible values: `pending`, `processing`, `sent`, `returned`, `canceled`, `error`. Filterable.", "type": "string" }, "trace_number": { "description": "15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.", "type": "string" }, "trace_suffix": { "type": "integer" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The ach updated" } }, "summary": "Update an ACH", "tags": [ "ACH" ] } }, "/book": { "get": { "parameters": [ { "description": "ID of the account originating the transfer. Filterable.", "in": "query", "name": "from_account_id", "schema": { "type": "string" } }, { "description": "ID of the organization with which the object is associated. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "ID of the account receiving the transfer. Filterable.", "in": "query", "name": "to_account_id", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "description": null, "from_account_id": "acct_1234567890", "id": "book_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "description": { "description": "Optional description. Long descriptions may be truncated on legacy banking cores.", "type": "string" }, "error": { "description": "Error message describing why a book transfer failed to send", "type": "string" }, "from_account_id": { "description": "ID of the account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` book elements, starting after the book described by `page_cursor`. If no more books are available, the resulting list will be empty." } }, "summary": "List Book Transfers", "tags": [ "Book Transfer" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "amount": "100.00", "from_account_id": "acct_1234567890", "to_account_id": "acct_0987654321" } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "description": { "description": "Optional description. Long descriptions may be truncated on legacy banking cores.", "type": "string" }, "from_account_id": { "description": "ID of the account originating the transfer. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "required": [ "to_account_id", "amount", "from_account_id", "id" ] } } }, "description": "The book to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "description": null, "from_account_id": "acct_1234567890", "id": "book_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "description": { "description": "Optional description. Long descriptions may be truncated on legacy banking cores.", "type": "string" }, "error": { "description": "Error message describing why a book transfer failed to send", "type": "string" }, "from_account_id": { "description": "ID of the account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The book created" } }, "summary": "Create a Book Transfer", "tags": [ "Book Transfer" ] } }, "/book/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "description": null, "from_account_id": "acct_1234567890", "id": "book_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "description": { "description": "Optional description. Long descriptions may be truncated on legacy banking cores.", "type": "string" }, "error": { "description": "Error message describing why a book transfer failed to send", "type": "string" }, "from_account_id": { "description": "ID of the account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The book" } }, "summary": "Fetch a Book Transfer", "tags": [ "Book Transfer" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Updating userdata", "value": { "userdata": { "ok": "true" } } } }, "schema": { "properties": { "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The book to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "description": null, "from_account_id": "acct_1234567890", "id": "book_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": { "ok": "true" } } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "bankdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "description": { "description": "Optional description. Long descriptions may be truncated on legacy banking cores.", "type": "string" }, "error": { "description": "Error message describing why a book transfer failed to send", "type": "string" }, "from_account_id": { "description": "ID of the account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The book updated" } }, "summary": "Update a Book Transfer", "tags": [ "Book Transfer" ] } }, "/check": { "get": { "parameters": [ { "description": "ID of the Account issuing the check. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "ID of the organization with which the object is associated. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "Status of check. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_11gag8g8aw8tzv", "amount": "10.05", "check_date": "2021-11-09T22:39:48Z", "check_number": "12012", "created_at": "2021-11-09T22:39:48Z", "id": "ch_11grny5mfhvjnp", "memo": "presidential pension", "message": "Presidential pension for November 2021. Please deposit within 60 days.", "recipient": { "address": { "city": "Washington", "postal_code": "20003", "state": "DC", "street_line_1": "1600 Pennsylvania Ave.", "street_line_2": "" }, "name": "George Washington" }, "status": "pending", "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account issuing the check. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "check_date": { "description": "Date on which the check was issued", "type": "string" }, "check_number": { "description": "The number printed on the issued check. Check numbers are automatically generated after check object creation", "type": "string" }, "delivery_method": { "description": "Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.", "type": "string" }, "error": { "description": "An error message of why the check is in error status.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional text to include on the memo line of the check (max of 40 characters)", "type": "string" }, "message": { "description": "Optional text to include on the bottom of the check page (maximum of 400 characters)", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "recipient": { "description": "Recipient of the check", "properties": { "address": { "description": "Address of the recipient", "properties": { "city": { "description": "City (max 21 characters)", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the recipient", "type": "string" } }, "type": "object" }, "signatory_name": { "description": "The name of the person or entity being used as the signatory on this check", "type": "string" }, "status": { "description": "Status of check. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` check elements, starting after the check described by `page_cursor`. If no more checks are available, the resulting list will be empty." } }, "summary": "List Issued Checks", "tags": [ "Check Issuing" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "acct_11gag8g8aw8tzv", "amount": "10.05", "memo": "presidential pension", "message": "Presidential pension for November 2021. Please deposit within 60 days.", "recipient": { "address": { "city": "Washington", "postal_code": "20003", "state": "DC", "street_line_1": "1600 Pennsylvania Ave.", "street_line_2": "" }, "name": "George Washington" } } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account issuing the check. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "check_date": { "description": "Date on which the check was issued", "type": "string" }, "delivery_method": { "description": "Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.", "type": "string" }, "memo": { "description": "Optional text to include on the memo line of the check (max of 40 characters)", "type": "string" }, "message": { "description": "Optional text to include on the bottom of the check page (maximum of 400 characters)", "type": "string" }, "recipient": { "description": "Recipient of the check", "properties": { "address": { "description": "Address of the recipient", "properties": { "city": { "description": "City (max 21 characters)", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the recipient", "type": "string" } }, "type": "object" }, "status": { "description": "Status of check. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "required": [ "amount", "account_id", "recipient", "id" ] } } }, "description": "The check to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11gag8g8aw8tzv", "amount": "10.05", "check_date": "2021-11-09T22:39:48Z", "check_number": "12012", "created_at": "2021-11-09T22:39:48Z", "id": "ch_11grny5mfhvjnp", "memo": "presidential pension", "message": "Presidential pension for November 2021. Please deposit within 60 days.", "recipient": { "address": { "city": "Washington", "postal_code": "20003", "state": "DC", "street_line_1": "1600 Pennsylvania Ave.", "street_line_2": "" }, "name": "George Washington" }, "status": "pending", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account issuing the check. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "check_date": { "description": "Date on which the check was issued", "type": "string" }, "check_number": { "description": "The number printed on the issued check. Check numbers are automatically generated after check object creation", "type": "string" }, "delivery_method": { "description": "Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.", "type": "string" }, "error": { "description": "An error message of why the check is in error status.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional text to include on the memo line of the check (max of 40 characters)", "type": "string" }, "message": { "description": "Optional text to include on the bottom of the check page (maximum of 400 characters)", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "recipient": { "description": "Recipient of the check", "properties": { "address": { "description": "Address of the recipient", "properties": { "city": { "description": "City (max 21 characters)", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the recipient", "type": "string" } }, "type": "object" }, "signatory_name": { "description": "The name of the person or entity being used as the signatory on this check", "type": "string" }, "status": { "description": "Status of check. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The check created" } }, "summary": "Issue a Check", "tags": [ "Check Issuing" ] } }, "/check/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11gag8g8aw8tzv", "amount": "10.05", "check_date": "2021-11-09T22:39:48Z", "check_number": "12012", "created_at": "2021-11-09T22:39:48Z", "id": "ch_11grny5mfhvjnp", "memo": "presidential pension", "message": "Presidential pension for November 2021. Please deposit within 60 days.", "recipient": { "address": { "city": "Washington", "postal_code": "20003", "state": "DC", "street_line_1": "1600 Pennsylvania Ave.", "street_line_2": "" }, "name": "George Washington" }, "status": "pending", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account issuing the check. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "check_date": { "description": "Date on which the check was issued", "type": "string" }, "check_number": { "description": "The number printed on the issued check. Check numbers are automatically generated after check object creation", "type": "string" }, "delivery_method": { "description": "Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.", "type": "string" }, "error": { "description": "An error message of why the check is in error status.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional text to include on the memo line of the check (max of 40 characters)", "type": "string" }, "message": { "description": "Optional text to include on the bottom of the check page (maximum of 400 characters)", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "recipient": { "description": "Recipient of the check", "properties": { "address": { "description": "Address of the recipient", "properties": { "city": { "description": "City (max 21 characters)", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the recipient", "type": "string" } }, "type": "object" }, "signatory_name": { "description": "The name of the person or entity being used as the signatory on this check", "type": "string" }, "status": { "description": "Status of check. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The check" } }, "summary": "Fetch an Issued Check", "tags": [ "Check Issuing" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "status": "stop_payment_pending" } } }, "schema": { "properties": { "status": { "description": "New status of check, one of: `canceled`, `stop_payment`", "type": "string" } } } } }, "description": "The check to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11gag8g8aw8tzv", "amount": "10.05", "check_date": "2021-11-09T22:39:48Z", "check_number": "12012", "created_at": "2021-11-09T22:39:48Z", "id": "ch_11grny5mfhvjnp", "memo": "presidential pension", "message": "Presidential pension for November 2021. Please deposit within 60 days.", "recipient": { "address": { "city": "Washington", "postal_code": "20003", "state": "DC", "street_line_1": "1600 Pennsylvania Ave.", "street_line_2": "" }, "name": "George Washington" }, "status": "stop_payment_pending", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account issuing the check. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "check_date": { "description": "Date on which the check was issued", "type": "string" }, "check_number": { "description": "The number printed on the issued check. Check numbers are automatically generated after check object creation", "type": "string" }, "delivery_method": { "description": "Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.", "type": "string" }, "error": { "description": "An error message of why the check is in error status.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional text to include on the memo line of the check (max of 40 characters)", "type": "string" }, "message": { "description": "Optional text to include on the bottom of the check page (maximum of 400 characters)", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "recipient": { "description": "Recipient of the check", "properties": { "address": { "description": "Address of the recipient", "properties": { "city": { "description": "City (max 21 characters)", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the recipient", "type": "string" } }, "type": "object" }, "signatory_name": { "description": "The name of the person or entity being used as the signatory on this check", "type": "string" }, "status": { "description": "Status of check. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The check updated" } }, "summary": "Update an Issued Check", "tags": [ "Check Issuing" ] } }, "/check_deposit": { "get": { "parameters": [ { "description": "ID of the Account receiving the deposit. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Flag indicating the check was manually decisioned. Filterable.", "in": "query", "name": "decisioned", "schema": { "enum": [ "true", "false" ], "type": "string" } }, { "description": "ID of the organization with which the object is associated. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "One of `pending`, `pending_review`, `submitted`, `sent`, `error`, `canceled_OCR`, or `returned`. Indicates the deposit's current status in the check workflow. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "amount": "100.00", "amount_discrepancy_detected": false, "back_image_file_id": "file_0987654321", "created_at": "2017-11-02T11:55:14Z", "decision_data": {}, "device": { "os_name": "ios", "os_version": "12" }, "error": null, "front_image_file_id": "file_1234567890", "id": "chk_1029384756", "ocr_account_number": "1234567890", "ocr_amount": "100.00", "ocr_check_number": "5250", "ocr_routing_number": "021001208", "org_id": "org_1gwmpv3payf", "person_id": "owner_1234567890", "rdc_provider_full": {}, "review_information": [], "risk_rating": "Accept", "risk_rating_description": "Risk rating assessment by RDC provider", "status": "submitted", "updated_at": "2017-11-02T11:56:31Z", "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account receiving the deposit. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision. This must match the amount stated on the check", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "amount_discrepancy_detected": { "description": "Flag indicating amount mismatch between `amount` and check image", "type": "boolean" }, "back_image_file_id": { "description": "ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images", "type": "string" }, "decision_data": { "description": "Context related to check decisioning", "properties": { "decided_at": { "description": "Timestamp of when the decision was made", "type": "string" }, "decided_by": { "description": "ID of the user who made the decision", "type": "string" }, "decision": { "description": "Outcome of manual check review", "type": "string" } }, "type": "object" }, "decisioned": { "description": "Flag indicating the check was manually decisioned. Filterable.", "enum": [ "true", "false" ], "type": "string" }, "device": { "description": "Information on the device that captured the images", "properties": { "os_name": { "description": "Name of the operating system the device is running. One of `android`, `blackberry`, `ios`, `windows`, or `unknown`", "type": "string" }, "os_version": { "description": "Major version number of the operating system the device is running (e.g. '12', '7', etc.), or the string `unknown`", "type": "string" } }, "type": "object" }, "error": { "description": "Error message describing why a check was declined", "type": "string" }, "front_image_file_id": { "description": "ID of the .jpg file object representing an image of the front of the check. Currently we only accept JPG file format for images", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ocr_account_number": { "description": "Account number detected in check image", "type": "string" }, "ocr_amount": { "description": "Amount detected in check image", "type": "string" }, "ocr_check_number": { "description": "Check number detected in check image", "type": "string" }, "ocr_routing_number": { "description": "Routing number detected in check image", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "person_id": { "description": "ID of the Person making the deposit. This ID must be in the array of person_ids of the account receiving the deposit", "type": "string" }, "rdc_provider_full": { "description": "Full response from RDC provider", "type": "object" }, "return_data": { "description": "Context related to returned checks", "properties": { "reason": { "description": "Reason the check is being returned", "type": "string" }, "returned_at": { "description": "Timestamp of when the check was returned", "type": "string" }, "returned_by": { "description": "ID of the user who returned the check", "type": "string" } }, "type": "object" }, "review_information": { "description": "Additional context to support check reviews", "items": { "type": "object" }, "type": "array" }, "risk_rating": { "description": "Risk rating assessment by RDC provider", "type": "string" }, "risk_rating_description": { "description": "Human-readable risk rating", "type": "string" }, "status": { "description": "One of `pending`, `pending_review`, `submitted`, `sent`, `error`, `canceled_OCR`, or `returned`. Indicates the deposit's current status in the check workflow. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` check_deposit elements, starting after the check_deposit described by `page_cursor`. If no more check_deposits are available, the resulting list will be empty." } }, "summary": "List Check Deposits", "tags": [ "Check Deposit" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "acct_1234567890", "amount": "100.00", "back_image_file_id": "file_0987654321", "front_image_file_id": "file_1234567890", "person_id": "psn_1234567890" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the deposit. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision. This must match the amount stated on the check", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "back_image_file_id": { "description": "ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images", "type": "string" }, "decisioned": { "description": "Flag indicating the check was manually decisioned. Filterable.", "enum": [ "true", "false" ], "type": "string" }, "device": { "description": "Information on the device that captured the images", "properties": { "os_name": { "description": "Name of the operating system the device is running. One of `android`, `blackberry`, `ios`, `windows`, or `unknown`", "type": "string" }, "os_version": { "description": "Major version number of the operating system the device is running (e.g. '12', '7', etc.), or the string `unknown`", "type": "string" } }, "type": "object" }, "front_image_file_id": { "description": "ID of the .jpg file object representing an image of the front of the check. Currently we only accept JPG file format for images", "type": "string" }, "person_id": { "description": "ID of the Person making the deposit. This ID must be in the array of person_ids of the account receiving the deposit", "type": "string" }, "status": { "description": "One of `pending`, `pending_review`, `submitted`, `sent`, `error`, `canceled_OCR`, or `returned`. Indicates the deposit's current status in the check workflow. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "required": [ "back_image_file_id", "amount", "account_id", "person_id", "id", "device", "front_image_file_id" ] } } }, "description": "The check_deposit to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "100.00", "amount_discrepancy_detected": false, "back_image_file_id": "file_0987654321", "created_at": "2017-11-02T11:55:14Z", "decision_data": {}, "device": { "os_name": "ios", "os_version": "12" }, "error": null, "front_image_file_id": "file_1234567890", "id": "chk_1029384756", "ocr_account_number": "1234567890", "ocr_amount": "100.00", "ocr_check_number": "5250", "ocr_routing_number": "021001208", "org_id": "org_1gwmpv3payf", "person_id": "owner_1234567890", "rdc_provider_full": {}, "review_information": [], "risk_rating": "Accept", "risk_rating_description": "Risk rating assessment by RDC provider", "status": "submitted", "updated_at": "2017-11-02T11:56:31Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the deposit. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision. This must match the amount stated on the check", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "amount_discrepancy_detected": { "description": "Flag indicating amount mismatch between `amount` and check image", "type": "boolean" }, "back_image_file_id": { "description": "ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images", "type": "string" }, "decision_data": { "description": "Context related to check decisioning", "properties": { "decided_at": { "description": "Timestamp of when the decision was made", "type": "string" }, "decided_by": { "description": "ID of the user who made the decision", "type": "string" }, "decision": { "description": "Outcome of manual check review", "type": "string" } }, "type": "object" }, "decisioned": { "description": "Flag indicating the check was manually decisioned. Filterable.", "enum": [ "true", "false" ], "type": "string" }, "device": { "description": "Information on the device that captured the images", "properties": { "os_name": { "description": "Name of the operating system the device is running. One of `android`, `blackberry`, `ios`, `windows`, or `unknown`", "type": "string" }, "os_version": { "description": "Major version number of the operating system the device is running (e.g. '12', '7', etc.), or the string `unknown`", "type": "string" } }, "type": "object" }, "error": { "description": "Error message describing why a check was declined", "type": "string" }, "front_image_file_id": { "description": "ID of the .jpg file object representing an image of the front of the check. Currently we only accept JPG file format for images", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ocr_account_number": { "description": "Account number detected in check image", "type": "string" }, "ocr_amount": { "description": "Amount detected in check image", "type": "string" }, "ocr_check_number": { "description": "Check number detected in check image", "type": "string" }, "ocr_routing_number": { "description": "Routing number detected in check image", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "person_id": { "description": "ID of the Person making the deposit. This ID must be in the array of person_ids of the account receiving the deposit", "type": "string" }, "rdc_provider_full": { "description": "Full response from RDC provider", "type": "object" }, "return_data": { "description": "Context related to returned checks", "properties": { "reason": { "description": "Reason the check is being returned", "type": "string" }, "returned_at": { "description": "Timestamp of when the check was returned", "type": "string" }, "returned_by": { "description": "ID of the user who returned the check", "type": "string" } }, "type": "object" }, "review_information": { "description": "Additional context to support check reviews", "items": { "type": "object" }, "type": "array" }, "risk_rating": { "description": "Risk rating assessment by RDC provider", "type": "string" }, "risk_rating_description": { "description": "Human-readable risk rating", "type": "string" }, "status": { "description": "One of `pending`, `pending_review`, `submitted`, `sent`, `error`, `canceled_OCR`, or `returned`. Indicates the deposit's current status in the check workflow. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The check_deposit created" } }, "summary": "Create a Check Deposit", "tags": [ "Check Deposit" ] } }, "/check_deposit/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "100.00", "amount_discrepancy_detected": false, "back_image_file_id": "file_0987654321", "created_at": "2017-11-02T11:55:14Z", "decision_data": {}, "device": { "os_name": "ios", "os_version": "12" }, "error": null, "front_image_file_id": "file_1234567890", "id": "chk_1029384756", "ocr_account_number": "1234567890", "ocr_amount": "100.00", "ocr_check_number": "5250", "ocr_routing_number": "021001208", "org_id": "org_1gwmpv3payf", "person_id": "owner_1234567890", "rdc_provider_full": {}, "review_information": [], "risk_rating": "Accept", "risk_rating_description": "Risk rating assessment by RDC provider", "status": "submitted", "updated_at": "2017-11-02T11:56:31Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the deposit. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision. This must match the amount stated on the check", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "amount_discrepancy_detected": { "description": "Flag indicating amount mismatch between `amount` and check image", "type": "boolean" }, "back_image_file_id": { "description": "ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images", "type": "string" }, "decision_data": { "description": "Context related to check decisioning", "properties": { "decided_at": { "description": "Timestamp of when the decision was made", "type": "string" }, "decided_by": { "description": "ID of the user who made the decision", "type": "string" }, "decision": { "description": "Outcome of manual check review", "type": "string" } }, "type": "object" }, "decisioned": { "description": "Flag indicating the check was manually decisioned. Filterable.", "enum": [ "true", "false" ], "type": "string" }, "device": { "description": "Information on the device that captured the images", "properties": { "os_name": { "description": "Name of the operating system the device is running. One of `android`, `blackberry`, `ios`, `windows`, or `unknown`", "type": "string" }, "os_version": { "description": "Major version number of the operating system the device is running (e.g. '12', '7', etc.), or the string `unknown`", "type": "string" } }, "type": "object" }, "error": { "description": "Error message describing why a check was declined", "type": "string" }, "front_image_file_id": { "description": "ID of the .jpg file object representing an image of the front of the check. Currently we only accept JPG file format for images", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ocr_account_number": { "description": "Account number detected in check image", "type": "string" }, "ocr_amount": { "description": "Amount detected in check image", "type": "string" }, "ocr_check_number": { "description": "Check number detected in check image", "type": "string" }, "ocr_routing_number": { "description": "Routing number detected in check image", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "person_id": { "description": "ID of the Person making the deposit. This ID must be in the array of person_ids of the account receiving the deposit", "type": "string" }, "rdc_provider_full": { "description": "Full response from RDC provider", "type": "object" }, "return_data": { "description": "Context related to returned checks", "properties": { "reason": { "description": "Reason the check is being returned", "type": "string" }, "returned_at": { "description": "Timestamp of when the check was returned", "type": "string" }, "returned_by": { "description": "ID of the user who returned the check", "type": "string" } }, "type": "object" }, "review_information": { "description": "Additional context to support check reviews", "items": { "type": "object" }, "type": "array" }, "risk_rating": { "description": "Risk rating assessment by RDC provider", "type": "string" }, "risk_rating_description": { "description": "Human-readable risk rating", "type": "string" }, "status": { "description": "One of `pending`, `pending_review`, `submitted`, `sent`, `error`, `canceled_OCR`, or `returned`. Indicates the deposit's current status in the check workflow. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The check_deposit" } }, "summary": "Fetch a Check Deposit", "tags": [ "Check Deposit" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Decisioning a check", "value": { "status": "submitted" } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision. This must match the amount stated on the check", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "status": { "description": "One of `submitted` or `error`. Indicates the deposit's decisioned status in the check workflow. Filterable.", "type": "string" } } } } }, "description": "The check_deposit to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "100.00", "amount_discrepancy_detected": false, "back_image_file_id": "file_0987654321", "created_at": "2017-11-02T11:55:14Z", "decision_data": {}, "device": { "os_name": "ios", "os_version": "12" }, "error": null, "front_image_file_id": "file_1234567890", "id": "chk_1029384756", "ocr_account_number": "1234567890", "ocr_amount": "100.00", "ocr_check_number": "5250", "ocr_routing_number": "021001208", "org_id": "org_1gwmpv3payf", "person_id": "owner_1234567890", "rdc_provider_full": {}, "review_information": [], "risk_rating": "Accept", "risk_rating_description": "Risk rating assessment by RDC provider", "status": "submitted", "updated_at": "2017-11-02T11:56:31Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the deposit. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision. This must match the amount stated on the check", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "amount_discrepancy_detected": { "description": "Flag indicating amount mismatch between `amount` and check image", "type": "boolean" }, "back_image_file_id": { "description": "ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images", "type": "string" }, "decision_data": { "description": "Context related to check decisioning", "properties": { "decided_at": { "description": "Timestamp of when the decision was made", "type": "string" }, "decided_by": { "description": "ID of the user who made the decision", "type": "string" }, "decision": { "description": "Outcome of manual check review", "type": "string" } }, "type": "object" }, "decisioned": { "description": "Flag indicating the check was manually decisioned. Filterable.", "enum": [ "true", "false" ], "type": "string" }, "device": { "description": "Information on the device that captured the images", "properties": { "os_name": { "description": "Name of the operating system the device is running. One of `android`, `blackberry`, `ios`, `windows`, or `unknown`", "type": "string" }, "os_version": { "description": "Major version number of the operating system the device is running (e.g. '12', '7', etc.), or the string `unknown`", "type": "string" } }, "type": "object" }, "error": { "description": "Error message describing why a check was declined", "type": "string" }, "front_image_file_id": { "description": "ID of the .jpg file object representing an image of the front of the check. Currently we only accept JPG file format for images", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ocr_account_number": { "description": "Account number detected in check image", "type": "string" }, "ocr_amount": { "description": "Amount detected in check image", "type": "string" }, "ocr_check_number": { "description": "Check number detected in check image", "type": "string" }, "ocr_routing_number": { "description": "Routing number detected in check image", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "person_id": { "description": "ID of the Person making the deposit. This ID must be in the array of person_ids of the account receiving the deposit", "type": "string" }, "rdc_provider_full": { "description": "Full response from RDC provider", "type": "object" }, "return_data": { "description": "Context related to returned checks", "properties": { "reason": { "description": "Reason the check is being returned", "type": "string" }, "returned_at": { "description": "Timestamp of when the check was returned", "type": "string" }, "returned_by": { "description": "ID of the user who returned the check", "type": "string" } }, "type": "object" }, "review_information": { "description": "Additional context to support check reviews", "items": { "type": "object" }, "type": "array" }, "risk_rating": { "description": "Risk rating assessment by RDC provider", "type": "string" }, "risk_rating_description": { "description": "Human-readable risk rating", "type": "string" }, "status": { "description": "One of `pending`, `pending_review`, `submitted`, `sent`, `error`, `canceled_OCR`, or `returned`. Indicates the deposit's current status in the check workflow. Filterable.", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The check_deposit updated" } }, "summary": "Update a Check Deposit", "tags": [ "Check Deposit" ] } }, "/counterparty": { "get": { "parameters": [ { "description": "Name of the account owner. Filterable.", "in": "query", "name": "name_on_account", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "ach": { "account_number": "64141601", "account_type": "checking", "routing_number": "021001208" }, "created_at": "2017-11-02T11:55:14Z", "id": "cp_1029384756", "name_on_account": "George Washington", "plaid_processor_token": null, "updated_at": "2017-11-02T11:55:14Z", "userdata": null, "wire": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "ach": { "description": "Account information for use with ACH transfers", "properties": { "account_number": { "description": "Bank account number for ACH use (maximum of 17 characters)", "type": "string" }, "account_type": { "description": "Either `checking` or `savings`.", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "name_on_account": { "description": "Name of the account owner. Filterable.", "type": "string" }, "plaid_processor_token": { "description": "Plaid processor token, exchanged for an account number and routing number", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" }, "wire": { "description": "Account information for use with wire transfers", "properties": { "account_number": { "description": "Bank account number for wire use (maximum of 34 characters)", "type": "string" }, "address_on_account": { "description": "Physical address associated with the account", "properties": { "city": { "description": "City (max 35 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (two letter abbreviation for US, max 35 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_address": { "description": "Address of the bank", "properties": { "city": { "description": "City (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "country": { "description": "A 2 character ISO country code. Required for an international counterparty", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "street_line_1": { "description": "Street address (first line) (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Street address (second line, if applicable) (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code", "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` counterparty elements, starting after the counterparty described by `page_cursor`. If no more counterpartys are available, the resulting list will be empty." } }, "summary": "List Counterparties", "tags": [ "Counterparty" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "ach": { "account_number": "64141601", "account_type": "checking", "routing_number": "021001208" }, "name_on_account": "George Washington" } } }, "schema": { "properties": { "ach": { "description": "Account information for use with ACH transfers", "properties": { "account_number": { "description": "Bank account number for ACH use (maximum of 17 characters)", "type": "string" }, "account_type": { "description": "Either `checking` or `savings`.", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.", "type": "string" } }, "type": "object" }, "name_on_account": { "description": "Name of the account owner. Filterable.", "type": "string" }, "plaid_processor_token": { "description": "Plaid processor token, exchanged for an account number and routing number", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" }, "wire": { "description": "Account information for use with wire transfers", "properties": { "account_number": { "description": "Bank account number for wire use (maximum of 34 characters)", "type": "string" }, "address_on_account": { "description": "Physical address associated with the account", "properties": { "city": { "description": "City (max 35 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (two letter abbreviation for US, max 35 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_address": { "description": "Address of the bank", "properties": { "city": { "description": "City (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "country": { "description": "A 2 character ISO country code. Required for an international counterparty", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "street_line_1": { "description": "Street address (first line) (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Street address (second line, if applicable) (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code", "type": "string" } }, "type": "object" } }, "required": [ "name_on_account", "id" ] } } }, "description": "The counterparty to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "ach": { "account_number": "64141601", "account_type": "checking", "routing_number": "021001208" }, "created_at": "2017-11-02T11:55:14Z", "id": "cp_1029384756", "name_on_account": "George Washington", "plaid_processor_token": null, "updated_at": "2017-11-02T11:55:14Z", "userdata": null, "wire": null } } }, "schema": { "properties": { "ach": { "description": "Account information for use with ACH transfers", "properties": { "account_number": { "description": "Bank account number for ACH use (maximum of 17 characters)", "type": "string" }, "account_type": { "description": "Either `checking` or `savings`.", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "name_on_account": { "description": "Name of the account owner. Filterable.", "type": "string" }, "plaid_processor_token": { "description": "Plaid processor token, exchanged for an account number and routing number", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" }, "wire": { "description": "Account information for use with wire transfers", "properties": { "account_number": { "description": "Bank account number for wire use (maximum of 34 characters)", "type": "string" }, "address_on_account": { "description": "Physical address associated with the account", "properties": { "city": { "description": "City (max 35 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (two letter abbreviation for US, max 35 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_address": { "description": "Address of the bank", "properties": { "city": { "description": "City (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "country": { "description": "A 2 character ISO country code. Required for an international counterparty", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "street_line_1": { "description": "Street address (first line) (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Street address (second line, if applicable) (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code", "type": "string" } }, "type": "object" } } } } }, "description": "The counterparty created" } }, "summary": "Create a Counterparty", "tags": [ "Counterparty" ] } }, "/counterparty/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "ach": { "account_number": "64141601", "account_type": "checking", "routing_number": "021001208" }, "created_at": "2017-11-02T11:55:14Z", "id": "cp_1029384756", "name_on_account": "George Washington", "plaid_processor_token": null, "updated_at": "2017-11-02T11:55:14Z", "userdata": null, "wire": null } } }, "schema": { "properties": { "ach": { "description": "Account information for use with ACH transfers", "properties": { "account_number": { "description": "Bank account number for ACH use (maximum of 17 characters)", "type": "string" }, "account_type": { "description": "Either `checking` or `savings`.", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "name_on_account": { "description": "Name of the account owner. Filterable.", "type": "string" }, "plaid_processor_token": { "description": "Plaid processor token, exchanged for an account number and routing number", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" }, "wire": { "description": "Account information for use with wire transfers", "properties": { "account_number": { "description": "Bank account number for wire use (maximum of 34 characters)", "type": "string" }, "address_on_account": { "description": "Physical address associated with the account", "properties": { "city": { "description": "City (max 35 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (two letter abbreviation for US, max 35 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_address": { "description": "Address of the bank", "properties": { "city": { "description": "City (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "country": { "description": "A 2 character ISO country code. Required for an international counterparty", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "street_line_1": { "description": "Street address (first line) (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Street address (second line, if applicable) (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code", "type": "string" } }, "type": "object" } } } } }, "description": "The counterparty" } }, "summary": "Fetch a Counterparty", "tags": [ "Counterparty" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Updating userdata", "value": { "userdata": { "ok": "true" } } } }, "schema": { "properties": { "userdata": { "type": "object" } } } } }, "description": "The counterparty to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "ach": { "account_number": "64141601", "account_type": "checking", "routing_number": "021001208" }, "created_at": "2017-11-02T11:55:14Z", "id": "cp_1029384756", "name_on_account": "George Washington", "plaid_processor_token": null, "updated_at": "2017-11-02T11:55:14Z", "userdata": { "ok": "true" }, "wire": null } } }, "schema": { "properties": { "ach": { "description": "Account information for use with ACH transfers", "properties": { "account_number": { "description": "Bank account number for ACH use (maximum of 17 characters)", "type": "string" }, "account_type": { "description": "Either `checking` or `savings`.", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "name_on_account": { "description": "Name of the account owner. Filterable.", "type": "string" }, "plaid_processor_token": { "description": "Plaid processor token, exchanged for an account number and routing number", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" }, "wire": { "description": "Account information for use with wire transfers", "properties": { "account_number": { "description": "Bank account number for wire use (maximum of 34 characters)", "type": "string" }, "address_on_account": { "description": "Physical address associated with the account", "properties": { "city": { "description": "City (max 35 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (two letter abbreviation for US, max 35 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_address": { "description": "Address of the bank", "properties": { "city": { "description": "City (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "country": { "description": "A 2 character ISO country code. Required for an international counterparty", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region (max 35 characters). If omitted, populated from the Routing Number record for the wire counterparty; if no record is on file, the request is rejected.", "type": "string" }, "street_line_1": { "description": "Street address (first line) (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Street address (second line, if applicable) (max 35 characters)", "type": "string" } }, "type": "object" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code", "type": "string" } }, "type": "object" } } } } }, "description": "The counterparty updated" } }, "summary": "Update a Counterparty", "tags": [ "Counterparty" ] } }, "/fednow": { "get": { "parameters": [ { "description": "ID of the account. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "ID of the bank. Filterable.", "in": "query", "name": "bank_id", "schema": { "type": "string" } }, { "description": "External account number. Filterable.", "in": "query", "name": "external_account_number", "schema": { "type": "string" } }, { "description": "Status of originated payment at the external account. Only populated for sent payments. One of `pending`, `processing`, `done`, `rejected`, `blocked`, or `error`. Filterable.", "in": "query", "name": "external_status", "schema": { "type": "string" } }, { "description": "ID of the organization. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "FedNow payment ID. Filterable.", "in": "query", "name": "payment_id", "schema": { "type": "string" } }, { "description": "One of `pending`, `processing`, `sent`, `done`, or `error`. The available values for status are driven by payment type. Successful credits (incoming) terminate in `done`. Debits (outgoing) terminate in `sent`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_11kpbg3r130zjwr", "amount": "100.00", "bank_id": "bank_acme", "created_at": "2024-01-01T00:00:00Z", "currency": "USD", "description": "FedNow transfer 202503243211779688172026683739635", "error": null, "external_account_number": "123456789", "external_name": "John Doe", "external_reject_reason": null, "external_routing_number": "987654321", "external_status": "pending", "fed_settlement_date": "2024-01-01", "id": "fednow_11ky35224fez5zb", "memo": "Cherry trees", "org_id": "org_acme", "originator_name": "Jane Doe", "payment_id": "202503243211779688172026683739635", "payment_type": "debit", "related_fednow_ids": [ "202503243211779688172026683739633", "202503243211779688172026683739634" ], "security_context": { "device_id": "a1b2c3d4e5f6", "ip_address": "192.168.1.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" }, "status": "pending", "updated_at": "2024-01-01T00:00:00Z" } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the account. Filterable.", "type": "string" }, "amount": { "description": "Amount of the payment", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank. Filterable.", "type": "string" }, "created_at": { "description": "When this object was created", "type": "string" }, "currency": { "description": "Currency of the payment", "type": "string" }, "description": { "description": "Optional description of the payment", "type": "string" }, "error": { "description": "Error message describing why the payment failed", "type": "string" }, "external_account_number": { "description": "External account number. Filterable.", "type": "string" }, "external_name": { "description": "External account name", "type": "string" }, "external_reject_reason": { "description": "Rejection reason information for rejected payments. Only present for payments rejected by FedNow or counterparty.", "properties": { "reason_code": { "description": "ISO 20022 or FedNow proprietary reason code for rejected payments.", "type": "string" }, "reason_description": { "description": "Description of the rejection reason code.", "type": "string" } }, "type": "object" }, "external_routing_number": { "description": "External routing number", "type": "string" }, "external_status": { "description": "Status of originated payment at the external account. Only populated for sent payments. One of `pending`, `processing`, `done`, `rejected`, `blocked`, or `error`. Filterable.", "type": "string" }, "fed_settlement_date": { "description": "Settlement date from FedNow", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional memo for the payment", "type": "string" }, "org_id": { "description": "ID of the organization. Filterable.", "type": "string" }, "originator_name": { "description": "Optional sender name for the payment", "type": "string" }, "payment_id": { "description": "FedNow payment ID. Filterable.", "type": "string" }, "payment_type": { "description": "One of `credit` or `debit`", "type": "string" }, "related_fednow_ids": { "description": "An array of IDs for related FedNow payments", "items": { "type": "string" }, "type": "array" }, "security_context": { "description": "Context for this submission", "properties": { "device_id": { "description": "Unique identifier for the device", "type": "string" }, "ip_address": { "description": "IP address of the user", "type": "string" }, "user_agent": { "description": "User agent string of the client", "type": "string" } }, "type": "object" }, "status": { "description": "One of `pending`, `processing`, `sent`, `done`, or `error`. The available values for status are driven by payment type. Successful credits (incoming) terminate in `done`. Debits (outgoing) terminate in `sent`. Filterable.", "type": "string" }, "updated_at": { "description": "When this object was last updated", "type": "string" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` fednow elements, starting after the fednow described by `page_cursor`. If no more fednows are available, the resulting list will be empty." } }, "summary": "List FedNow Payments", "tags": [ "FedNow" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "123456", "amount": "100.00", "external_account_number": "123456789", "external_name": "Jane Doe", "external_routing_number": "000000000", "memo": "Invoice #053", "originator_name": "John Doe", "security_context": { "device_id": "2f4a3f0005614323a61ac09918d29129", "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0" } } } }, "schema": { "properties": { "account_id": { "description": "ID of the account. Filterable.", "type": "string" }, "amount": { "description": "Amount of the payment", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "description": { "description": "Optional description of the payment", "type": "string" }, "external_account_number": { "description": "External account number. Filterable.", "type": "string" }, "external_name": { "description": "External account name", "type": "string" }, "external_routing_number": { "description": "External routing number", "type": "string" }, "memo": { "description": "Optional memo for the payment", "type": "string" }, "originator_name": { "description": "Optional sender name for the payment", "type": "string" }, "security_context": { "description": "Context for this submission", "properties": { "device_id": { "description": "Unique identifier for the device", "type": "string" }, "ip_address": { "description": "IP address of the user", "type": "string" }, "user_agent": { "description": "User agent string of the client", "type": "string" } }, "type": "object" } }, "required": [ "amount", "account_id", "external_routing_number", "id", "external_name", "external_account_number" ] } } }, "description": "The fednow to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11kpbg3r130zjwr", "amount": "100.00", "bank_id": "bank_acme", "created_at": "2024-01-01T00:00:00Z", "currency": "USD", "description": "FedNow transfer 202503243211779688172026683739635", "error": null, "external_account_number": "123456789", "external_name": "John Doe", "external_reject_reason": null, "external_routing_number": "987654321", "external_status": "pending", "fed_settlement_date": "2024-01-01", "id": "fednow_11ky35224fez5zb", "memo": "Cherry trees", "org_id": "org_acme", "originator_name": "Jane Doe", "payment_id": "202503243211779688172026683739635", "payment_type": "debit", "related_fednow_ids": [ "202503243211779688172026683739633", "202503243211779688172026683739634" ], "security_context": { "device_id": "a1b2c3d4e5f6", "ip_address": "192.168.1.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" }, "status": "pending", "updated_at": "2024-01-01T00:00:00Z" } } }, "schema": { "properties": { "account_id": { "description": "ID of the account. Filterable.", "type": "string" }, "amount": { "description": "Amount of the payment", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank. Filterable.", "type": "string" }, "created_at": { "description": "When this object was created", "type": "string" }, "currency": { "description": "Currency of the payment", "type": "string" }, "description": { "description": "Optional description of the payment", "type": "string" }, "error": { "description": "Error message describing why the payment failed", "type": "string" }, "external_account_number": { "description": "External account number. Filterable.", "type": "string" }, "external_name": { "description": "External account name", "type": "string" }, "external_reject_reason": { "description": "Rejection reason information for rejected payments. Only present for payments rejected by FedNow or counterparty.", "properties": { "reason_code": { "description": "ISO 20022 or FedNow proprietary reason code for rejected payments.", "type": "string" }, "reason_description": { "description": "Description of the rejection reason code.", "type": "string" } }, "type": "object" }, "external_routing_number": { "description": "External routing number", "type": "string" }, "external_status": { "description": "Status of originated payment at the external account. Only populated for sent payments. One of `pending`, `processing`, `done`, `rejected`, `blocked`, or `error`. Filterable.", "type": "string" }, "fed_settlement_date": { "description": "Settlement date from FedNow", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional memo for the payment", "type": "string" }, "org_id": { "description": "ID of the organization. Filterable.", "type": "string" }, "originator_name": { "description": "Optional sender name for the payment", "type": "string" }, "payment_id": { "description": "FedNow payment ID. Filterable.", "type": "string" }, "payment_type": { "description": "One of `credit` or `debit`", "type": "string" }, "related_fednow_ids": { "description": "An array of IDs for related FedNow payments", "items": { "type": "string" }, "type": "array" }, "security_context": { "description": "Context for this submission", "properties": { "device_id": { "description": "Unique identifier for the device", "type": "string" }, "ip_address": { "description": "IP address of the user", "type": "string" }, "user_agent": { "description": "User agent string of the client", "type": "string" } }, "type": "object" }, "status": { "description": "One of `pending`, `processing`, `sent`, `done`, or `error`. The available values for status are driven by payment type. Successful credits (incoming) terminate in `done`. Debits (outgoing) terminate in `sent`. Filterable.", "type": "string" }, "updated_at": { "description": "When this object was last updated", "type": "string" } } } } }, "description": "The fednow created" } }, "summary": "Create a FedNow Payment", "tags": [ "FedNow" ] } }, "/fednow/routing_number/{routing_number}": { "get": { "parameters": [ { "description": "Routing number of the bank", "in": "path", "name": "routing_number", "required": true, "schema": { "description": "Routing number of the bank", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "online": true, "receive": true, "routing_number": "011000015", "send": false } } }, "schema": { "properties": { "online": { "type": "boolean" }, "receive": { "type": "boolean" }, "routing_number": { "description": "Routing number of the bank", "type": "string" }, "send": { "type": "boolean" } } } } }, "description": "The :fednow.status" } }, "summary": "Check External FI FedNow Status", "tags": [ "FedNow" ] } }, "/fednow/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11kpbg3r130zjwr", "amount": "100.00", "bank_id": "bank_acme", "created_at": "2024-01-01T00:00:00Z", "currency": "USD", "description": "FedNow transfer 202503243211779688172026683739635", "error": null, "external_account_number": "123456789", "external_name": "John Doe", "external_reject_reason": null, "external_routing_number": "987654321", "external_status": "pending", "fed_settlement_date": "2024-01-01", "id": "fednow_11ky35224fez5zb", "memo": "Cherry trees", "org_id": "org_acme", "originator_name": "Jane Doe", "payment_id": "202503243211779688172026683739635", "payment_type": "debit", "related_fednow_ids": [ "202503243211779688172026683739633", "202503243211779688172026683739634" ], "security_context": { "device_id": "a1b2c3d4e5f6", "ip_address": "192.168.1.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)" }, "status": "pending", "updated_at": "2024-01-01T00:00:00Z" } } }, "schema": { "properties": { "account_id": { "description": "ID of the account. Filterable.", "type": "string" }, "amount": { "description": "Amount of the payment", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank. Filterable.", "type": "string" }, "created_at": { "description": "When this object was created", "type": "string" }, "currency": { "description": "Currency of the payment", "type": "string" }, "description": { "description": "Optional description of the payment", "type": "string" }, "error": { "description": "Error message describing why the payment failed", "type": "string" }, "external_account_number": { "description": "External account number. Filterable.", "type": "string" }, "external_name": { "description": "External account name", "type": "string" }, "external_reject_reason": { "description": "Rejection reason information for rejected payments. Only present for payments rejected by FedNow or counterparty.", "properties": { "reason_code": { "description": "ISO 20022 or FedNow proprietary reason code for rejected payments.", "type": "string" }, "reason_description": { "description": "Description of the rejection reason code.", "type": "string" } }, "type": "object" }, "external_routing_number": { "description": "External routing number", "type": "string" }, "external_status": { "description": "Status of originated payment at the external account. Only populated for sent payments. One of `pending`, `processing`, `done`, `rejected`, `blocked`, or `error`. Filterable.", "type": "string" }, "fed_settlement_date": { "description": "Settlement date from FedNow", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "memo": { "description": "Optional memo for the payment", "type": "string" }, "org_id": { "description": "ID of the organization. Filterable.", "type": "string" }, "originator_name": { "description": "Optional sender name for the payment", "type": "string" }, "payment_id": { "description": "FedNow payment ID. Filterable.", "type": "string" }, "payment_type": { "description": "One of `credit` or `debit`", "type": "string" }, "related_fednow_ids": { "description": "An array of IDs for related FedNow payments", "items": { "type": "string" }, "type": "array" }, "security_context": { "description": "Context for this submission", "properties": { "device_id": { "description": "Unique identifier for the device", "type": "string" }, "ip_address": { "description": "IP address of the user", "type": "string" }, "user_agent": { "description": "User agent string of the client", "type": "string" } }, "type": "object" }, "status": { "description": "One of `pending`, `processing`, `sent`, `done`, or `error`. The available values for status are driven by payment type. Successful credits (incoming) terminate in `done`. Debits (outgoing) terminate in `sent`. Filterable.", "type": "string" }, "updated_at": { "description": "When this object was last updated", "type": "string" } } } } }, "description": "The fednow" } }, "summary": "Fetch a FedNow Payment", "tags": [ "FedNow" ] } }, "/greendot": { "get": { "parameters": [ { "description": "ID of the Account receiving the cash load. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Current status of the cash load. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "amount": "25.00", "authorized_at": "2024-01-15T14:30:00Z", "available_at": null, "bank_id": "bank_vado", "barcode_number": "1234567890", "channel_type": "mobile", "completed_at": null, "created_at": "2024-01-15T14:30:00Z", "device_type": "mobile", "email_address": "example@example.com", "expired_at": null, "expires_at": "2024-01-15T14:45:00Z", "id": "gdep_1029384756", "ip_address": "192.168.1.100", "latitude": "39.724121", "longitude": "-94.793228", "retailer_key": "1234", "status": "pending", "updated_at": "2024-01-15T14:30:00Z", "voided_at": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account receiving the cash load. Filterable.", "type": "string" }, "amount": { "description": "Amount of money being loaded. It cannot be specified when creating the barcode.", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "authorized_at": { "description": "Timestamp when the cash load was authorized", "type": "string" }, "available_at": { "description": "Timestamp when funds became available", "type": "string" }, "bank_id": { "description": "ID of the bank with which this object is associated", "type": "string" }, "barcode_number": { "description": "The barcode number used to generate a barcode image for scanning at the Point of Sale", "type": "string" }, "channel_type": { "description": "Where is the cash load barcode being generated", "type": "string" }, "completed_at": { "description": "Timestamp when the cash load was completed", "type": "string" }, "device_type": { "description": "Type of device used for the cash load", "type": "string" }, "email_address": { "description": "Verified email address of the end user the cash load is for", "type": "string" }, "error": { "description": "The reason the deposit was voided during the authorization phase. Not every voided deposit will have an error. But deposits voided by Treasury Prime will have an error.", "type": "string" }, "expired_at": { "description": "Timestamp when the cash load expired", "type": "string" }, "expires_at": { "description": "Timestamp of when the cash load will expire. This is defined by Green Dot when the barcode is created.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ip_address": { "description": "IP address of the client device from which the cash load was initiated", "type": "string" }, "latitude": { "description": "Latitude of the client's device when generating the barcode", "type": "string" }, "longitude": { "description": "Longitude of the client's device when generating the barcode", "type": "string" }, "metadata": { "description": "Metadata from Green Dot. This data is populated when the cash load is authorized.", "type": "object" }, "retailer_key": { "description": "Retail key identifier from Green Dot", "type": "string" }, "status": { "description": "Current status of the cash load. Filterable.", "type": "string" }, "voided_at": { "description": "Timestamp when the cash load was voided", "type": "string" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` greendot elements, starting after the greendot described by `page_cursor`. If no more greendots are available, the resulting list will be empty." } }, "summary": "List Green Dot Cash Loads", "tags": [ "Green Dot" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": {}, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the cash load. Filterable.", "type": "string" }, "channel_type": { "description": "Where is the cash load barcode being generated", "type": "string" }, "device_type": { "description": "Type of device used for the cash load", "type": "string" }, "email_address": { "description": "Verified email address of the end user the cash load is for", "type": "string" }, "ip_address": { "description": "IP address of the client device from which the cash load was initiated", "type": "string" }, "latitude": { "description": "Latitude of the client's device when generating the barcode", "type": "string" }, "longitude": { "description": "Longitude of the client's device when generating the barcode", "type": "string" }, "retailer_key": { "description": "Retail key identifier from Green Dot", "type": "string" } }, "required": [ "device_type", "account_id", "channel_type", "ip_address", "longitude", "latitude", "email_address", "retailer_key" ] } } }, "description": "The greendot to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "25.00", "authorized_at": "2024-01-15T14:30:00Z", "available_at": null, "bank_id": "bank_vado", "barcode_number": "1234567890", "channel_type": "mobile", "completed_at": null, "created_at": "2024-01-15T14:30:00Z", "device_type": "mobile", "email_address": "example@example.com", "expired_at": null, "expires_at": "2024-01-15T14:45:00Z", "id": "gdep_1029384756", "ip_address": "192.168.1.100", "latitude": "39.724121", "longitude": "-94.793228", "retailer_key": "1234", "status": "pending", "updated_at": "2024-01-15T14:30:00Z", "voided_at": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the cash load. Filterable.", "type": "string" }, "amount": { "description": "Amount of money being loaded. It cannot be specified when creating the barcode.", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "authorized_at": { "description": "Timestamp when the cash load was authorized", "type": "string" }, "available_at": { "description": "Timestamp when funds became available", "type": "string" }, "bank_id": { "description": "ID of the bank with which this object is associated", "type": "string" }, "barcode_number": { "description": "The barcode number used to generate a barcode image for scanning at the Point of Sale", "type": "string" }, "channel_type": { "description": "Where is the cash load barcode being generated", "type": "string" }, "completed_at": { "description": "Timestamp when the cash load was completed", "type": "string" }, "device_type": { "description": "Type of device used for the cash load", "type": "string" }, "email_address": { "description": "Verified email address of the end user the cash load is for", "type": "string" }, "error": { "description": "The reason the deposit was voided during the authorization phase. Not every voided deposit will have an error. But deposits voided by Treasury Prime will have an error.", "type": "string" }, "expired_at": { "description": "Timestamp when the cash load expired", "type": "string" }, "expires_at": { "description": "Timestamp of when the cash load will expire. This is defined by Green Dot when the barcode is created.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ip_address": { "description": "IP address of the client device from which the cash load was initiated", "type": "string" }, "latitude": { "description": "Latitude of the client's device when generating the barcode", "type": "string" }, "longitude": { "description": "Longitude of the client's device when generating the barcode", "type": "string" }, "metadata": { "description": "Metadata from Green Dot. This data is populated when the cash load is authorized.", "type": "object" }, "retailer_key": { "description": "Retail key identifier from Green Dot", "type": "string" }, "status": { "description": "Current status of the cash load. Filterable.", "type": "string" }, "voided_at": { "description": "Timestamp when the cash load was voided", "type": "string" } } } } }, "description": "The greendot created" }, "400": { "content": { "application/json": { "examples": { "bad-request": { "summary": "Bad request", "value": { "error": "The provided latitude is invalid" } } } } }, "description": "Failed to create greendot" }, "503": { "content": { "application/json": { "examples": { "greendot-system-error": { "summary": "Green Dot system error", "value": { "error": "Green Dot is currently experiencing issues on their end. Please try again later." } } } } }, "description": "Failed to create greendot" } }, "summary": "Create a Green Dot Cash Load", "tags": [ "Green Dot" ] } }, "/greendot/location": { "get": { "parameters": [ { "description": "IP address of the client device making this request. Filterable.", "in": "query", "name": "ip_address", "schema": { "type": "string" } }, { "description": "Latitude of the retail location. Required along with longitude if zip_code is not provided. Filterable.", "in": "query", "name": "latitude", "schema": { "type": "string" } }, { "description": "Longitude of the retail location. Required along with latitude if zip_code is not provided. Filterable.", "in": "query", "name": "longitude", "schema": { "type": "string" } }, { "description": "Zip code/Postal code of the retailer. Required if latitude and longitude are not provided. Filterable.", "in": "query", "name": "zip_code", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "address": "200 12th St SW", "city": "Forest Lake", "customer_fee": "3.74", "latitude": "45.27678600", "longitude": "-93.00201300", "phone": "6514649740", "retailer_key": "2812", "retailer_name": "Walmart Supercenter", "state": "MN", "store_id": "Walmart Supercenter2274", "zip_code": "55025" } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "address": { "description": "Street address of the Green Dot retailer", "type": "string" }, "city": { "description": "City of the retail location", "type": "string" }, "customer_fee": { "description": "Fee that will be charged for cash loads at this location", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "latitude": { "description": "Latitude of the retail location. Required along with longitude if zip_code is not provided. Filterable.", "type": "string" }, "longitude": { "description": "Longitude of the retail location. Required along with latitude if zip_code is not provided. Filterable.", "type": "string" }, "phone": { "description": "Phone number for the retail location", "type": "string" }, "retailer_key": { "description": "Retail key identifier from Green Dot, this is used for barcode generation API", "type": "string" }, "retailer_name": { "description": "Name of the retailer supporting Green Dot", "type": "string" }, "state": { "description": "State/province of the retail location", "type": "string" }, "store_id": { "description": "Store ID of the retail location, not used by the barcode generation API", "type": "string" }, "zip_code": { "description": "Zip code/Postal code of the retailer. Required if latitude and longitude are not provided. Filterable.", "type": "string" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` greendot_location elements, starting after the greendot_location described by `page_cursor`. If no more greendot_locations are available, the resulting list will be empty." } }, "summary": "Fetch Green Dot Retail Locations", "tags": [ "Green Dot" ] } }, "/greendot/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "25.00", "authorized_at": "2024-01-15T14:30:00Z", "available_at": null, "bank_id": "bank_vado", "barcode_number": "1234567890", "channel_type": "mobile", "completed_at": null, "created_at": "2024-01-15T14:30:00Z", "device_type": "mobile", "email_address": "example@example.com", "expired_at": null, "expires_at": "2024-01-15T14:45:00Z", "id": "gdep_1029384756", "ip_address": "192.168.1.100", "latitude": "39.724121", "longitude": "-94.793228", "retailer_key": "1234", "status": "pending", "updated_at": "2024-01-15T14:30:00Z", "voided_at": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the cash load. Filterable.", "type": "string" }, "amount": { "description": "Amount of money being loaded. It cannot be specified when creating the barcode.", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "authorized_at": { "description": "Timestamp when the cash load was authorized", "type": "string" }, "available_at": { "description": "Timestamp when funds became available", "type": "string" }, "bank_id": { "description": "ID of the bank with which this object is associated", "type": "string" }, "barcode_number": { "description": "The barcode number used to generate a barcode image for scanning at the Point of Sale", "type": "string" }, "channel_type": { "description": "Where is the cash load barcode being generated", "type": "string" }, "completed_at": { "description": "Timestamp when the cash load was completed", "type": "string" }, "device_type": { "description": "Type of device used for the cash load", "type": "string" }, "email_address": { "description": "Verified email address of the end user the cash load is for", "type": "string" }, "error": { "description": "The reason the deposit was voided during the authorization phase. Not every voided deposit will have an error. But deposits voided by Treasury Prime will have an error.", "type": "string" }, "expired_at": { "description": "Timestamp when the cash load expired", "type": "string" }, "expires_at": { "description": "Timestamp of when the cash load will expire. This is defined by Green Dot when the barcode is created.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "ip_address": { "description": "IP address of the client device from which the cash load was initiated", "type": "string" }, "latitude": { "description": "Latitude of the client's device when generating the barcode", "type": "string" }, "longitude": { "description": "Longitude of the client's device when generating the barcode", "type": "string" }, "metadata": { "description": "Metadata from Green Dot. This data is populated when the cash load is authorized.", "type": "object" }, "retailer_key": { "description": "Retail key identifier from Green Dot", "type": "string" }, "status": { "description": "Current status of the cash load. Filterable.", "type": "string" }, "voided_at": { "description": "Timestamp when the cash load was voided", "type": "string" } } } } }, "description": "The greendot" } }, "summary": "Fetch a Green Dot Cash Load", "tags": [ "Green Dot" ] } }, "/hold": { "get": { "parameters": [ { "description": "ID of the Account to place the hold. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Status of the hold, one of `active`, `released`, or `expired`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "amount": "10.00", "bank_id": "bank_treasuryprime", "expires_at": "2023-11-09T22:39:48Z", "hold_description": "Hold description", "hold_release_description": "Released description", "hold_transaction_id": "ttx_1234567890", "id": "mhold_1234567890", "org_id": "org_fintech", "release_transaction_id": null, "status": "active" } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account to place the hold. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to hold, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "expires_at": { "description": "Optional timestamp to expire the hold", "type": "string" }, "hold_description": { "description": "Optional description for the hold transaction", "type": "string" }, "hold_release_description": { "description": "Optional description for the hold release transaction", "type": "string" }, "hold_transaction_id": { "description": "ID of the hold transaction", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "release_transaction_id": { "description": "ID of the hold release transaction", "type": "string" }, "status": { "description": "Status of the hold, one of `active`, `released`, or `expired`. Filterable.", "type": "string" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` manual_hold elements, starting after the manual_hold described by `page_cursor`. If no more manual_holds are available, the resulting list will be empty." } }, "summary": "List Manual Holds", "tags": [ "Manual Hold" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "acct_1234567890", "amount": "10.00", "expires_at": "2023-11-09T22:39:48Z", "hold_description": "Hold description", "hold_release_description": "Released description" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account to place the hold. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to hold, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "expires_at": { "description": "Optional timestamp to expire the hold", "type": "string" }, "hold_description": { "description": "Optional description for the hold transaction", "type": "string" }, "hold_release_description": { "description": "Optional description for the hold release transaction", "type": "string" } }, "required": [ "amount", "account_id", "id" ] } } }, "description": "The manual_hold to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "10.00", "bank_id": "bank_treasuryprime", "expires_at": "2023-11-09T22:39:48Z", "hold_description": "Hold description", "hold_release_description": "Released description", "hold_transaction_id": "ttx_1234567890", "id": "mhold_1234567890", "org_id": "org_fintech", "release_transaction_id": null, "status": "active" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account to place the hold. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to hold, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "expires_at": { "description": "Optional timestamp to expire the hold", "type": "string" }, "hold_description": { "description": "Optional description for the hold transaction", "type": "string" }, "hold_release_description": { "description": "Optional description for the hold release transaction", "type": "string" }, "hold_transaction_id": { "description": "ID of the hold transaction", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "release_transaction_id": { "description": "ID of the hold release transaction", "type": "string" }, "status": { "description": "Status of the hold, one of `active`, `released`, or `expired`. Filterable.", "type": "string" } } } } }, "description": "The manual_hold created" } }, "summary": "Create a Manual Hold", "tags": [ "Manual Hold" ] } }, "/hold/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "10.00", "bank_id": "bank_treasuryprime", "expires_at": "2023-11-09T22:39:48Z", "hold_description": "Hold description", "hold_release_description": "Released description", "hold_transaction_id": "ttx_1234567890", "id": "mhold_1234567890", "org_id": "org_fintech", "release_transaction_id": null, "status": "active" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account to place the hold. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to hold, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "expires_at": { "description": "Optional timestamp to expire the hold", "type": "string" }, "hold_description": { "description": "Optional description for the hold transaction", "type": "string" }, "hold_release_description": { "description": "Optional description for the hold release transaction", "type": "string" }, "hold_transaction_id": { "description": "ID of the hold transaction", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "release_transaction_id": { "description": "ID of the hold release transaction", "type": "string" }, "status": { "description": "Status of the hold, one of `active`, `released`, or `expired`. Filterable.", "type": "string" } } } } }, "description": "The manual_hold" } }, "summary": "Fetch a Manual Hold", "tags": [ "Manual Hold" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "status": "released" } } }, "schema": { "properties": { "hold_release_description": { "description": "New transaction description to use when releasing the hold", "type": "string" }, "status": { "description": "New status of hold (must be `released`)", "type": "string" } } } } }, "description": "The manual_hold to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "10.00", "bank_id": "bank_treasuryprime", "expires_at": "2023-11-09T22:39:48Z", "hold_description": "Hold description", "hold_release_description": "Released description", "hold_transaction_id": "ttx_1234567890", "id": "mhold_1234567890", "org_id": "org_fintech", "release_transaction_id": "ttx_9876543210", "status": "released" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account to place the hold. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to hold, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "expires_at": { "description": "Optional timestamp to expire the hold", "type": "string" }, "hold_description": { "description": "Optional description for the hold transaction", "type": "string" }, "hold_release_description": { "description": "Optional description for the hold release transaction", "type": "string" }, "hold_transaction_id": { "description": "ID of the hold transaction", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "release_transaction_id": { "description": "ID of the hold release transaction", "type": "string" }, "status": { "description": "Status of the hold, one of `active`, `released`, or `expired`. Filterable.", "type": "string" } } } } }, "description": "The manual_hold updated" } }, "summary": "Update a Manual Hold", "tags": [ "Manual Hold" ] } }, "/incoming_ach": { "get": { "parameters": [ { "description": "ID of the Account receiving the transfer. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Receiving bank account number. Filterable.", "in": "query", "name": "account_number", "schema": { "type": "string" } }, { "description": "ID of the transaction that the incoming ACH is directly related to. Filterable.", "in": "query", "name": "original_transaction_id", "schema": { "type": "string" } }, { "description": "One of `done`, `failed`, `pending`, or `returned`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_11jbx6ve3c8an", "account_number": "1371971315", "account_type": "checking", "amount": "100.00", "bank_id": "bank_treasuryprime", "company_desc": null, "company_id": "000000000", "company_name": "Prime of Treasury Inc.", "created_at": "2023-08-15T14:47:35Z", "description": null, "direction": "credit", "effective_date": "2023-08-15", "id": "inach_11jdq4073ea9k", "nacha_body": { "batches": [ { "_mac": "", "batch_number": 1, "company": { "id": "823419438", "name": "Example Corp" }, "description": "LOREM IPSUM", "descriptive_date": "", "discretionary_data": "", "effective_date": "2021-04-14T00:00:00Z", "entries": [ { "addenda": [], "amount": 25, "direction": "credit", "discretionary_data": "", "id_number": "11gap2hytfy17a", "receiver": { "account_number": "123456798", "account_type": "checking", "name": "George Washington", "routing_number": "017014038" }, "trace_number": "24015053925610", "transaction_type": "payment" } ], "odfi_id": "02806504", "originator_status_code": "dfi", "sec_code": "ppd", "settlement_date": "167" } ], "created_at": "2021-04-12T11:25:00.000Z", "destination": { "id": " 074000022", "name": "EXAMPLE BANK NON CO" }, "file_id": "K", "origin": { "id": " 075000051", "name": "M&I" }, "reference_code": "" }, "name": null, "org_id": "org_1h648t6pkmg", "original_transaction_id": null, "related_transaction_ids": [], "sec_code": "ccd", "status": "done", "trace_number": "1692110855251", "transaction_code": null, "updated_at": "2023-08-15T14:47:35Z" } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "account_number": { "description": "Receiving bank account number. Filterable.", "type": "string" }, "account_type": { "description": "The type of the receiving account, such as `checking` or `savings`", "type": "string" }, "amount": { "description": "Amount of money transferred, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the account is associated", "type": "string" }, "company_desc": { "description": "10-character field that can be used by the originator to describe the payment", "type": "string" }, "company_id": { "description": "Code that the originating bank uses to identify the originator", "type": "string" }, "company_name": { "description": "Name of the company initiating the incoming ACH", "type": "string" }, "description": { "description": "Description that appears on the transaction record associated with the incoming ACH object", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (money deposited into this account), or `debit` (money withdrawn from this account)", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network", "type": "string" }, "exception_type": { "description": "The exception that caused this ACH to be returned", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "nacha_body": { "description": "Data from the relevant NACHA file about the incoming ACH", "properties": { "batches": { "items": { "type": "object" }, "type": "array" }, "destination": { "type": "object" }, "file_id": { "type": "string" }, "origin": { "type": "object" }, "reference_code": { "type": "string" } }, "type": "object" }, "name": { "description": "The name of the receiver as obtained from the incoming ACH", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "original_transaction_id": { "description": "ID of the transaction that the incoming ACH is directly related to. Filterable.", "type": "string" }, "related_transaction_ids": { "description": "List of all transaction IDs associated with the incoming ACH", "items": { "type": "string" }, "type": "array" }, "sec_code": { "description": "One of `arc`, `ccd`, `cie`, `cor`, `ctx`, `dne`, `iat`, `pos`, `ppd`, `tel`, or `web`. Specifies the transfer type, according to the ACH network", "type": "string" }, "signature": { "description": "A hash of the ACH fields designed to provide a unique identifier", "type": "string" }, "status": { "description": "One of `done`, `failed`, `pending`, or `returned`. Filterable.", "type": "string" }, "trace_number": { "description": "Internal identifier used by the originating bank", "type": "string" }, "transaction_code": { "description": "Transaction code for this entry in the NACHA file", "type": "string" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` incoming_ach elements, starting after the incoming_ach described by `page_cursor`. If no more incoming_achs are available, the resulting list will be empty." } }, "summary": "List Incoming ACHs", "tags": [ "Incoming ACH" ] } }, "/incoming_ach/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11jbx6ve3c8an", "account_number": "1371971315", "account_type": "checking", "amount": "100.00", "bank_id": "bank_treasuryprime", "company_desc": null, "company_id": "000000000", "company_name": "Prime of Treasury Inc.", "created_at": "2023-08-15T14:47:35Z", "description": null, "direction": "credit", "effective_date": "2023-08-15", "id": "inach_11jdq4073ea9k", "nacha_body": { "batches": [ { "_mac": "", "batch_number": 1, "company": { "id": "823419438", "name": "Example Corp" }, "description": "LOREM IPSUM", "descriptive_date": "", "discretionary_data": "", "effective_date": "2021-04-14T00:00:00Z", "entries": [ { "addenda": [], "amount": 25, "direction": "credit", "discretionary_data": "", "id_number": "11gap2hytfy17a", "receiver": { "account_number": "123456798", "account_type": "checking", "name": "George Washington", "routing_number": "017014038" }, "trace_number": "24015053925610", "transaction_type": "payment" } ], "odfi_id": "02806504", "originator_status_code": "dfi", "sec_code": "ppd", "settlement_date": "167" } ], "created_at": "2021-04-12T11:25:00.000Z", "destination": { "id": " 074000022", "name": "EXAMPLE BANK NON CO" }, "file_id": "K", "origin": { "id": " 075000051", "name": "M&I" }, "reference_code": "" }, "name": null, "org_id": "org_1h648t6pkmg", "original_transaction_id": null, "related_transaction_ids": [], "sec_code": "ccd", "status": "done", "trace_number": "1692110855251", "transaction_code": null, "updated_at": "2023-08-15T14:47:35Z" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "account_number": { "description": "Receiving bank account number. Filterable.", "type": "string" }, "account_type": { "description": "The type of the receiving account, such as `checking` or `savings`", "type": "string" }, "amount": { "description": "Amount of money transferred, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the account is associated", "type": "string" }, "company_desc": { "description": "10-character field that can be used by the originator to describe the payment", "type": "string" }, "company_id": { "description": "Code that the originating bank uses to identify the originator", "type": "string" }, "company_name": { "description": "Name of the company initiating the incoming ACH", "type": "string" }, "description": { "description": "Description that appears on the transaction record associated with the incoming ACH object", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (money deposited into this account), or `debit` (money withdrawn from this account)", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network", "type": "string" }, "exception_type": { "description": "The exception that caused this ACH to be returned", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "nacha_body": { "description": "Data from the relevant NACHA file about the incoming ACH", "properties": { "batches": { "items": { "type": "object" }, "type": "array" }, "destination": { "type": "object" }, "file_id": { "type": "string" }, "origin": { "type": "object" }, "reference_code": { "type": "string" } }, "type": "object" }, "name": { "description": "The name of the receiver as obtained from the incoming ACH", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "original_transaction_id": { "description": "ID of the transaction that the incoming ACH is directly related to. Filterable.", "type": "string" }, "related_transaction_ids": { "description": "List of all transaction IDs associated with the incoming ACH", "items": { "type": "string" }, "type": "array" }, "sec_code": { "description": "One of `arc`, `ccd`, `cie`, `cor`, `ctx`, `dne`, `iat`, `pos`, `ppd`, `tel`, or `web`. Specifies the transfer type, according to the ACH network", "type": "string" }, "signature": { "description": "A hash of the ACH fields designed to provide a unique identifier", "type": "string" }, "status": { "description": "One of `done`, `failed`, `pending`, or `returned`. Filterable.", "type": "string" }, "trace_number": { "description": "Internal identifier used by the originating bank", "type": "string" }, "transaction_code": { "description": "Transaction code for this entry in the NACHA file", "type": "string" } } } } }, "description": "The incoming_ach" } }, "summary": "Fetch an Incoming ACH", "tags": [ "Incoming ACH" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Returning an incoming ACH", "value": { "description": "Returned as fraudulent", "return_code": "R29", "status": "return" } } }, "schema": { "properties": { "description": { "description": "Optional transaction description used when posting the return to the ledger", "type": "string" }, "return_code": { "description": "Return code to use when returning the incoming ACH. One of: `R10`, `R20`, or `R29`", "type": "string" }, "status": { "description": "Updated status for the incoming ACH. Possible values: `return` to return a payment", "type": "string" } } } } }, "description": "The incoming_ach to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_11jbx6ve3c8an", "account_number": "1371971315", "account_type": "checking", "amount": "100.00", "bank_id": "bank_treasuryprime", "company_desc": null, "company_id": "000000000", "company_name": "Prime of Treasury Inc.", "created_at": "2023-08-15T14:47:35Z", "description": "Returned as fraudulent", "direction": "credit", "effective_date": "2023-08-15", "id": "inach_11jdq4073ea9k", "nacha_body": { "batches": [ { "_mac": "", "batch_number": 1, "company": { "id": "823419438", "name": "Example Corp" }, "description": "LOREM IPSUM", "descriptive_date": "", "discretionary_data": "", "effective_date": "2021-04-14T00:00:00Z", "entries": [ { "addenda": [], "amount": 25, "direction": "credit", "discretionary_data": "", "id_number": "11gap2hytfy17a", "receiver": { "account_number": "123456798", "account_type": "checking", "name": "George Washington", "routing_number": "017014038" }, "trace_number": "24015053925610", "transaction_type": "payment" } ], "odfi_id": "02806504", "originator_status_code": "dfi", "sec_code": "ppd", "settlement_date": "167" } ], "created_at": "2021-04-12T11:25:00.000Z", "destination": { "id": " 074000022", "name": "EXAMPLE BANK NON CO" }, "file_id": "K", "origin": { "id": " 075000051", "name": "M&I" }, "reference_code": "" }, "name": null, "org_id": "org_1h648t6pkmg", "original_transaction_id": null, "related_transaction_ids": [], "return_code": "R29", "sec_code": "ccd", "status": "return", "trace_number": "1692110855251", "transaction_code": null, "updated_at": "2023-08-15T14:47:35Z" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "account_number": { "description": "Receiving bank account number. Filterable.", "type": "string" }, "account_type": { "description": "The type of the receiving account, such as `checking` or `savings`", "type": "string" }, "amount": { "description": "Amount of money transferred, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the account is associated", "type": "string" }, "company_desc": { "description": "10-character field that can be used by the originator to describe the payment", "type": "string" }, "company_id": { "description": "Code that the originating bank uses to identify the originator", "type": "string" }, "company_name": { "description": "Name of the company initiating the incoming ACH", "type": "string" }, "description": { "description": "Description that appears on the transaction record associated with the incoming ACH object", "type": "string" }, "direction": { "description": "Direction of funds flow. One of `credit` (money deposited into this account), or `debit` (money withdrawn from this account)", "type": "string" }, "effective_date": { "description": "The official effective date of the transaction, according to the ACH network", "type": "string" }, "exception_type": { "description": "The exception that caused this ACH to be returned", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "nacha_body": { "description": "Data from the relevant NACHA file about the incoming ACH", "properties": { "batches": { "items": { "type": "object" }, "type": "array" }, "destination": { "type": "object" }, "file_id": { "type": "string" }, "origin": { "type": "object" }, "reference_code": { "type": "string" } }, "type": "object" }, "name": { "description": "The name of the receiver as obtained from the incoming ACH", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "original_transaction_id": { "description": "ID of the transaction that the incoming ACH is directly related to. Filterable.", "type": "string" }, "related_transaction_ids": { "description": "List of all transaction IDs associated with the incoming ACH", "items": { "type": "string" }, "type": "array" }, "sec_code": { "description": "One of `arc`, `ccd`, `cie`, `cor`, `ctx`, `dne`, `iat`, `pos`, `ppd`, `tel`, or `web`. Specifies the transfer type, according to the ACH network", "type": "string" }, "signature": { "description": "A hash of the ACH fields designed to provide a unique identifier", "type": "string" }, "status": { "description": "One of `done`, `failed`, `pending`, or `returned`. Filterable.", "type": "string" }, "trace_number": { "description": "Internal identifier used by the originating bank", "type": "string" }, "transaction_code": { "description": "Transaction code for this entry in the NACHA file", "type": "string" } } } } }, "description": "The incoming_ach updated" } }, "summary": "Update an Incoming ACH", "tags": [ "Incoming ACH" ] } }, "/incoming_wire": { "get": { "parameters": [ { "description": "ID of the Account receiving the transfer. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "ID of the organization with which the object is associated. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "One of `pending` `processing` `done` `failed`, or `returned`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "ID of the associated transaction. Filterable.", "in": "query", "name": "transaction_id", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "amount": "1000.90", "bank_id": "bank_treasuryprime", "beneficiary": { "address": [ "123 RAINBOW RD", "CITYNAME NY 12345" ], "bank_data": { "account_number": "210393290", "account_type": null, "address": [ "NEW YORK", "NY" ], "bank_name": "BANK NAME", "routing_number": "123456789" }, "name": "GEORGE WASHINGTON" }, "created_at": "2023-08-23T14:28:02Z", "id": "iw_11jec6341ss3nwa", "imad": { "parsed": { "cycle_date": "2023-08-23T00:00:00Z", "input_sequence_number": "000015", "input_source": "MMQFMP5F" }, "unparsed": "20230823MMQFMP5F000015" }, "org_id": "org_fintech", "originator": { "address": [ "123 PINE ST", "NEW YORK NY 12345" ], "bank_data": { "account_number": "1092901990", "account_type": null, "address": [ "NEW YORK", "NY" ], "bank_name": "FINANCIAL INSTITUTION", "routing_number": "123412341" }, "name": "JOHN ADAMS" }, "originator_to_beneficiary_info": "INCWIRE10", "received_at": "2023-08-23", "status": "done", "transaction_id": "ttx_1234567890", "updated_at": "2023-08-23T14:32:05Z", "wire_body": { "bnf": { "addr": [ "123 RAINBOW RD", "CITYNAME NY 12345" ], "id": "210393290", "name": "GEORGE WASHINGTON", "type": "X" }, "bus_func_code": "CTR", "charge_amt": 0, "credit_amt": 1000.9, "curr": "USD", "irn": 202308230023344, "obi": [ "INCWIRE10" ], "omad": { "appl_id": "FT03", "cycle_date": "20230823", "date": "0823", "lterm": "MMQFMPVH", "omsn": "000016", "time": "1011" }, "org": { "addr": [ "123 PINE ST", "NEW YORK NY 12345" ], "id": "1092901990", "name": "JOHN ADAMS", "type": "X" }, "orig_amt": 1000.9, "payment_date": "23-AUG-2023", "rcv_bank": { "addr": [ "NEW YORK", "NY" ], "id": "123456789", "name": "BANK NAME", "type": "F" }, "sender_imad": { "cycle_date": "20230823", "imsn": "000015", "lterm": "MMQFMP5F" }, "snd_bank": { "addr": [ "NEW YORK", "NY" ], "id": "123412341", "name": "FINANCIAL INSTITUTION", "type": "F" }, "subtype_code": "00", "type_code": "10", "value_date": "23-AUG-2023" } } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money transferred, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "beneficiary": { "description": "A sub-object containing information about the wire beneficiary", "properties": { "address": { "description": "Wire Bank Address sub-object", "items": { "type": "string" }, "type": "array" }, "bank_data": { "description": "Bank details", "properties": { "account_number": { "description": "Bank account number", "type": "string" }, "account_type": { "description": "Account type", "type": "string" }, "address": { "description": "Unparsed bank address data", "items": { "type": "string" }, "type": "array" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with this bank", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the intermediary bank (maximum of 35 characters)", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "imad": { "description": "An IMAD sub-object", "properties": { "parsed": { "description": "Parsed IMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date", "type": "string" }, "input_sequence_number": { "description": "A 6 digit number assigned for uniqueness", "type": "string" }, "input_source": { "description": "8 alphanumeric characters identifying the source", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "originator": { "description": "A sub-object containing information about the wire originator", "properties": { "address": { "description": "Wire Bank Address sub-object", "items": { "type": "string" }, "type": "array" }, "bank_data": { "description": "Bank details", "properties": { "account_number": { "description": "Bank account number", "type": "string" }, "account_type": { "description": "Account type", "type": "string" }, "address": { "description": "Unparsed bank address data", "items": { "type": "string" }, "type": "array" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with this bank", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the intermediary bank (maximum of 35 characters)", "type": "string" } }, "type": "object" }, "originator_to_beneficiary_info": { "description": "Optional additional information for the beneficiary", "type": "string" }, "received_at": { "description": "Timestamp of when the object was received", "type": "string" }, "status": { "description": "One of `pending` `processing` `done` `failed`, or `returned`. Filterable.", "type": "string" }, "transaction_id": { "description": "ID of the associated transaction. Filterable.", "type": "string" }, "wire_body": { "description": "Raw wire body", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` incoming_wire elements, starting after the incoming_wire described by `page_cursor`. If no more incoming_wires are available, the resulting list will be empty." } }, "summary": "List Incoming Wires", "tags": [ "Incoming Wire" ] } }, "/incoming_wire/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "1000.90", "bank_id": "bank_treasuryprime", "beneficiary": { "address": [ "123 RAINBOW RD", "CITYNAME NY 12345" ], "bank_data": { "account_number": "210393290", "account_type": null, "address": [ "NEW YORK", "NY" ], "bank_name": "BANK NAME", "routing_number": "123456789" }, "name": "GEORGE WASHINGTON" }, "created_at": "2023-08-23T14:28:02Z", "id": "iw_11jec6341ss3nwa", "imad": { "parsed": { "cycle_date": "2023-08-23T00:00:00Z", "input_sequence_number": "000015", "input_source": "MMQFMP5F" }, "unparsed": "20230823MMQFMP5F000015" }, "org_id": "org_fintech", "originator": { "address": [ "123 PINE ST", "NEW YORK NY 12345" ], "bank_data": { "account_number": "1092901990", "account_type": null, "address": [ "NEW YORK", "NY" ], "bank_name": "FINANCIAL INSTITUTION", "routing_number": "123412341" }, "name": "JOHN ADAMS" }, "originator_to_beneficiary_info": "INCWIRE10", "received_at": "2023-08-23", "status": "done", "transaction_id": "ttx_1234567890", "updated_at": "2023-08-23T14:32:05Z", "wire_body": { "bnf": { "addr": [ "123 RAINBOW RD", "CITYNAME NY 12345" ], "id": "210393290", "name": "GEORGE WASHINGTON", "type": "X" }, "bus_func_code": "CTR", "charge_amt": 0, "credit_amt": 1000.9, "curr": "USD", "irn": 202308230023344, "obi": [ "INCWIRE10" ], "omad": { "appl_id": "FT03", "cycle_date": "20230823", "date": "0823", "lterm": "MMQFMPVH", "omsn": "000016", "time": "1011" }, "org": { "addr": [ "123 PINE ST", "NEW YORK NY 12345" ], "id": "1092901990", "name": "JOHN ADAMS", "type": "X" }, "orig_amt": 1000.9, "payment_date": "23-AUG-2023", "rcv_bank": { "addr": [ "NEW YORK", "NY" ], "id": "123456789", "name": "BANK NAME", "type": "F" }, "sender_imad": { "cycle_date": "20230823", "imsn": "000015", "lterm": "MMQFMP5F" }, "snd_bank": { "addr": [ "NEW YORK", "NY" ], "id": "123412341", "name": "FINANCIAL INSTITUTION", "type": "F" }, "subtype_code": "00", "type_code": "10", "value_date": "23-AUG-2023" } } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money transferred, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "beneficiary": { "description": "A sub-object containing information about the wire beneficiary", "properties": { "address": { "description": "Wire Bank Address sub-object", "items": { "type": "string" }, "type": "array" }, "bank_data": { "description": "Bank details", "properties": { "account_number": { "description": "Bank account number", "type": "string" }, "account_type": { "description": "Account type", "type": "string" }, "address": { "description": "Unparsed bank address data", "items": { "type": "string" }, "type": "array" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with this bank", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the intermediary bank (maximum of 35 characters)", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "imad": { "description": "An IMAD sub-object", "properties": { "parsed": { "description": "Parsed IMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date", "type": "string" }, "input_sequence_number": { "description": "A 6 digit number assigned for uniqueness", "type": "string" }, "input_source": { "description": "8 alphanumeric characters identifying the source", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "originator": { "description": "A sub-object containing information about the wire originator", "properties": { "address": { "description": "Wire Bank Address sub-object", "items": { "type": "string" }, "type": "array" }, "bank_data": { "description": "Bank details", "properties": { "account_number": { "description": "Bank account number", "type": "string" }, "account_type": { "description": "Account type", "type": "string" }, "address": { "description": "Unparsed bank address data", "items": { "type": "string" }, "type": "array" }, "bank_name": { "description": "Name of the bank", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with this bank", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the intermediary bank (maximum of 35 characters)", "type": "string" } }, "type": "object" }, "originator_to_beneficiary_info": { "description": "Optional additional information for the beneficiary", "type": "string" }, "received_at": { "description": "Timestamp of when the object was received", "type": "string" }, "status": { "description": "One of `pending` `processing` `done` `failed`, or `returned`. Filterable.", "type": "string" }, "transaction_id": { "description": "ID of the associated transaction. Filterable.", "type": "string" }, "wire_body": { "description": "Raw wire body", "type": "object" } } } } }, "description": "The incoming_wire" } }, "summary": "Fetch an Incoming Wire", "tags": [ "Incoming Wire" ] } }, "/invoice_account_number": { "get": { "parameters": [ { "description": "ID of the account with which the object is associated. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Flag indicating whether payments with this account number will post. Defaults to `true`. Filterable.", "in": "query", "name": "active", "schema": { "type": "boolean" } }, { "description": "Tags associated with the object. Filterable.", "in": "query", "name": "tags", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "account_number": "1234567890", "active": true, "bank_id": "bank_treasuryprime", "id": "acctnum_1234567890", "org_id": "org_1234567890", "tags": [], "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the account with which the object is associated. Filterable.", "type": "string" }, "account_number": { "description": "Account number for use with incoming payments", "type": "string" }, "active": { "description": "Flag indicating whether payments with this account number will post. Defaults to `true`. Filterable.", "type": "boolean" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "tags": { "description": "Tags associated with the object. Filterable.", "items": { "type": "string" }, "type": "array" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` invoice_account_number elements, starting after the invoice_account_number described by `page_cursor`. If no more invoice_account_numbers are available, the resulting list will be empty." } }, "summary": "List Account Numbers", "tags": [ "Invoice Account Number" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "acct_1234567890" } } }, "schema": { "properties": { "account_id": { "description": "ID of the account with which the object is associated. Filterable.", "type": "string" }, "active": { "description": "Flag indicating whether payments with this account number will post. Defaults to `true`. Filterable.", "type": "boolean" }, "tags": { "description": "Tags associated with the object. Filterable.", "items": { "type": "string" }, "type": "array" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } }, "required": [ "account_id", "id" ] } } }, "description": "The invoice_account_number to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "account_number": "1234567890", "active": true, "bank_id": "bank_treasuryprime", "id": "acctnum_1234567890", "org_id": "org_1234567890", "tags": [], "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the account with which the object is associated. Filterable.", "type": "string" }, "account_number": { "description": "Account number for use with incoming payments", "type": "string" }, "active": { "description": "Flag indicating whether payments with this account number will post. Defaults to `true`. Filterable.", "type": "boolean" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "tags": { "description": "Tags associated with the object. Filterable.", "items": { "type": "string" }, "type": "array" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The invoice_account_number created" } }, "summary": "Create an Account Number", "tags": [ "Invoice Account Number" ] } }, "/invoice_account_number/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "account_number": "1234567890", "active": true, "bank_id": "bank_treasuryprime", "id": "acctnum_1234567890", "org_id": "org_1234567890", "tags": [], "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the account with which the object is associated. Filterable.", "type": "string" }, "account_number": { "description": "Account number for use with incoming payments", "type": "string" }, "active": { "description": "Flag indicating whether payments with this account number will post. Defaults to `true`. Filterable.", "type": "boolean" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "tags": { "description": "Tags associated with the object. Filterable.", "items": { "type": "string" }, "type": "array" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The invoice_account_number" } }, "summary": "Fetch an Account Number", "tags": [ "Invoice Account Number" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "active": false } } }, "schema": { "properties": { "active": { "description": "Flag indicating whether payments with this account number will post. Filterable.", "type": "boolean" }, "tags": { "description": "Tags associated with the object. Filterable.", "items": { "type": "string" }, "type": "array" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The invoice_account_number to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "account_number": "1234567890", "active": false, "bank_id": "bank_treasuryprime", "id": "acctnum_1234567890", "org_id": "org_1234567890", "tags": [], "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the account with which the object is associated. Filterable.", "type": "string" }, "account_number": { "description": "Account number for use with incoming payments", "type": "string" }, "active": { "description": "Flag indicating whether payments with this account number will post. Defaults to `true`. Filterable.", "type": "boolean" }, "bank_id": { "description": "ID of the bank with which the object is associated", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated", "type": "string" }, "tags": { "description": "Tags associated with the object. Filterable.", "items": { "type": "string" }, "type": "array" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The invoice_account_number updated" } }, "summary": "Update an Account Number", "tags": [ "Invoice Account Number" ] } }, "/network_transfer": { "get": { "parameters": [ { "description": "Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.", "in": "query", "name": "cross_bank", "schema": { "type": "boolean" } }, { "description": "ID of the Account originating the transfer. Filterable.", "in": "query", "name": "from_account_id", "schema": { "type": "string" } }, { "description": "ID of the organization with which this object is associated. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "ID of the Account receiving the transfer. Filterable.", "in": "query", "name": "to_account_id", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "cross_bank": true, "description": "Transfer", "estimated_settlement_at": "2017-11-02T11:55:14Z", "from_account_id": "acct_1234567890", "id": "nt_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "balanced_at": { "description": "Timestamp of when the balancing wire for the transfer was created/sent. Only present on `v2` transfers.", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "cross_bank": { "description": "Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.", "type": "boolean" }, "description": { "description": "Optional description", "type": "string" }, "error": { "description": "Error message describing why a transfer failed", "type": "string" }, "estimated_settlement_at": { "description": "Timestamp of when the network transfer is estimated to complete. This will be the current timestamp in all cases except when the Network Transfer is outside of the bank's operating hours. In this situation, the timestamp will be the next banking business day", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "version": { "description": "The API version used to create the network transfer", "type": "string" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` network_transfer elements, starting after the network_transfer described by `page_cursor`. If no more network_transfers are available, the resulting list will be empty." } }, "summary": "List Network Transfers", "tags": [ "Network Transfer" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "amount": "100.00", "description": "Transfer", "from_account_id": "acct_1234567890", "to_account_id": "acct_0987654321" } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "description": { "description": "Optional description", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" } }, "required": [ "to_account_id", "amount", "from_account_id", "id" ] } } }, "description": "The network_transfer to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "cross_bank": true, "description": "Transfer", "estimated_settlement_at": "2017-11-02T11:55:14Z", "from_account_id": "acct_1234567890", "id": "nt_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "balanced_at": { "description": "Timestamp of when the balancing wire for the transfer was created/sent. Only present on `v2` transfers.", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "cross_bank": { "description": "Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.", "type": "boolean" }, "description": { "description": "Optional description", "type": "string" }, "error": { "description": "Error message describing why a transfer failed", "type": "string" }, "estimated_settlement_at": { "description": "Timestamp of when the network transfer is estimated to complete. This will be the current timestamp in all cases except when the Network Transfer is outside of the bank's operating hours. In this situation, the timestamp will be the next banking business day", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "version": { "description": "The API version used to create the network transfer", "type": "string" } } } } }, "description": "The network_transfer created" } }, "summary": "Create a Network Transfer", "tags": [ "Network Transfer" ] } }, "/network_transfer/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "cross_bank": true, "description": "Transfer", "estimated_settlement_at": "2017-11-02T11:55:14Z", "from_account_id": "acct_1234567890", "id": "nt_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "balanced_at": { "description": "Timestamp of when the balancing wire for the transfer was created/sent. Only present on `v2` transfers.", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "cross_bank": { "description": "Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.", "type": "boolean" }, "description": { "description": "Optional description", "type": "string" }, "error": { "description": "Error message describing why a transfer failed", "type": "string" }, "estimated_settlement_at": { "description": "Timestamp of when the network transfer is estimated to complete. This will be the current timestamp in all cases except when the Network Transfer is outside of the bank's operating hours. In this situation, the timestamp will be the next banking business day", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "version": { "description": "The API version used to create the network transfer", "type": "string" } } } } }, "description": "The network_transfer" } }, "summary": "Fetch a Network Transfer", "tags": [ "Network Transfer" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Updating userdata", "value": { "userdata": { "ok": "true" } } } }, "schema": { "properties": { "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The network_transfer to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "cross_bank": true, "description": "Transfer", "estimated_settlement_at": "2017-11-02T11:55:14Z", "from_account_id": "acct_1234567890", "id": "nt_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": { "ok": "true" } } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "balanced_at": { "description": "Timestamp of when the balancing wire for the transfer was created/sent. Only present on `v2` transfers.", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "cross_bank": { "description": "Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.", "type": "boolean" }, "description": { "description": "Optional description", "type": "string" }, "error": { "description": "Error message describing why a transfer failed", "type": "string" }, "estimated_settlement_at": { "description": "Timestamp of when the network transfer is estimated to complete. This will be the current timestamp in all cases except when the Network Transfer is outside of the bank's operating hours. In this situation, the timestamp will be the next banking business day", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached for the bank's use", "type": "object" }, "version": { "description": "The API version used to create the network transfer", "type": "string" } } } } }, "description": "The network_transfer updated" } }, "summary": "Update a Network Transfer", "tags": [ "Network Transfer" ] } }, "/v2/network_transfer": { "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "amount": "100.00", "description": "Transfer", "from_account_id": "acct_1234567890", "to_account_id": "acct_0987654321" } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached to the object", "type": "object" } }, "required": [ "to_account_id", "amount", "from_account_id", "id" ] } } }, "description": "The v2_network_transfer to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "amount": "100.00", "created_at": "2017-11-02T11:55:14Z", "cross_bank": true, "description": "Transfer", "estimated_settlement_at": "2017-11-02T11:55:14Z", "from_account_id": "acct_1234567890", "id": "nt_1029384756", "status": "pending", "to_account_id": "acct_0987654321", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^[0-9]+[.][0-9][0-9]$", "type": "string" }, "balanced_at": { "description": "Timestamp of when the balancing wire for the transfer was created/sent. Only present on `v2` transfers.", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "cross_bank": { "description": "Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.", "type": "boolean" }, "description": { "description": "Optional description (maximum of 10 characters)", "type": "string" }, "error": { "description": "Error message describing why a transfer failed", "type": "string" }, "estimated_settlement_at": { "description": "Timestamp of when the network transfer is estimated to complete. This will be the current timestamp in all cases except when the Network Transfer is outside of the bank's operating hours. In this situation, the timestamp will be the next banking business day", "type": "string" }, "from_account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "id": { "description": "Unique identifier for object", "type": "string" }, "org_id": { "description": "ID of the organization with which the object is associated. Filterable.", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `sent`, or `error`. Filterable.", "type": "string" }, "to_account_id": { "description": "ID of the Account receiving the transfer. Filterable.", "type": "string" }, "userdata": { "description": "Optional arbitrary data that can be attached to the object", "type": "object" }, "version": { "description": "The API version used to create the network transfer", "type": "string" } } } } }, "description": "The v2_network_transfer created" } }, "summary": "Create v2 Network Transfer", "tags": [ "Network Transfer" ] } }, "/wire": { "get": { "parameters": [ { "description": "ID of the Account originating the transfer. Filterable.", "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.", "in": "query", "name": "counterparty_id", "schema": { "type": "string" } }, { "description": "ID of the organization with which this object is associated. Filterable.", "in": "query", "name": "org_id", "schema": { "type": "string" } }, { "description": "One of `pending`, `canceled`, `error`, or `sent`. Filterable.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Pagination cursor, value is the object ID.", "in": "query", "name": "page_cursor", "schema": { "type": "string" } }, { "description": "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in": "query", "name": "page_size", "schema": { "default": 100, "minimum": 1, "type": "integer" } }, { "description": "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "from_date", "schema": { "type": "string" } }, { "description": "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in": "query", "name": "to_date", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "data": [ { "account_id": "acct_1234567890", "amount": "10300.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "error": null, "id": "wire_1029384756", "imad": { "parsed": { "cycle_date": "20220719", "input_sequence_number": "999999", "input_source": "ABCDEFG" }, "unparsed": "20220719ABCDEFG999999" }, "instructions": null, "intermediary": null, "omad": { "parsed": { "cycle_date": "20220719", "frb_application_id": "FT01", "output_date": "0102", "output_destination": "MMQFMPTQ", "output_sequence_number": "000106", "output_time": "1030" }, "unparsed": "20170102MMQFMPTQ00010601021030FT01" }, "status": "pending", "uetr": "97ed4827-7b6f-4485-ad6c-2eb05c0e2a1c", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } ] } } }, "schema": { "properties": { "data": { "items": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "chips_ssn": { "description": "Optional value for Chips SSN", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "error": { "description": "Error message describing why a wire failed", "type": "string" }, "fx_quote": { "description": "Associated foreign exchange quote, if any. Only present for wires at some bank partners.", "properties": { "base_currency": { "description": "Starting currency for the foreign exchange quote", "type": "string" }, "rate": { "format": "float", "type": "number" }, "status": { "description": "Status of the foreign exchange quote", "type": "string" }, "target_currency": { "description": "Target currency for the foreign exchange quote", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "imad": { "description": "Optional Input Message Accountability Data. An ID often filled out by the banks, originating from fed processing", "properties": { "parsed": { "description": "Parsed IMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "input_sequence_number": { "description": "A 6 digit number assigned for uniqueness", "type": "string" }, "input_source": { "description": "8 Alpha or Alpha-Numeric characters identifying the source", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "instructions": { "description": "Optional instructions for the recipient (maximum of 140 characters)", "type": "string" }, "intermediary": { "description": "Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire", "properties": { "address": { "description": "Physical address of the bank", "properties": { "city": { "description": "City (max 18 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters for US, max 3 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the bank (maximum of 35 characters)", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the bank", "type": "string" } }, "type": "object" }, "omad": { "description": "Optional Output Message Accountability Data. An ID originating from fed processing, similar structure to IMAD but with more info", "properties": { "parsed": { "description": "Parsed OMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "frb_application_id": { "description": "Uniquely identifies the Fedwire Funds Service site that processed the message (i.e., FT01, FT02 or FT03)", "type": "string" }, "output_date": { "description": "4 digit MMDD. Paired with `output_time`", "type": "string" }, "output_destination": { "description": "8 Alpha or Alpha-Numeric characters identifying the destination. Comparable to the IMAD `input_source`", "type": "string" }, "output_sequence_number": { "description": "A 6 digit number assigned for uniqueness. Comparable to IMAD `input_sequence_number`", "type": "string" }, "output_time": { "description": "4 digit HHmm. Paired with `output_date`", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Output Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "purpose": { "description": "Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 35 characters, may be truncated to 16 characters for sending depending on bank)", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `error`, or `sent`. Filterable.", "type": "string" }, "target_currency_code": { "description": "Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.", "type": "string" }, "uetr": { "description": "Optional Unique End-to-end Transaction Reference. A UUID that identifies the wire end-to-end, originating from ISO 20022 processing", "type": "string" }, "userdata": { "description": "Optional arbitrary data the user can attach to the object", "type": "object" } }, "type": "object" }, "type": "array" } } } } }, "description": "A dictionary with a `data` property that contains a list of up to `page_size` wire elements, starting after the wire described by `page_cursor`. If no more wires are available, the resulting list will be empty." } }, "summary": "List Wire Transfers", "tags": [ "Wire" ] }, "post": { "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Example", "value": { "account_id": "acct_1234567890", "amount": "10300.00", "counterparty_id": "cp_0987654321" } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "instructions": { "description": "Optional instructions for the recipient (maximum of 140 characters)", "type": "string" }, "intermediary": { "description": "Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire", "properties": { "address": { "description": "Physical address of the bank", "properties": { "city": { "description": "City (max 18 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters for US, max 3 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the bank (maximum of 35 characters)", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the bank", "type": "string" } }, "type": "object" }, "purpose": { "description": "Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 35 characters, may be truncated to 16 characters for sending depending on bank)", "type": "string" }, "target_currency_code": { "description": "Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.", "type": "string" }, "userdata": { "description": "Optional arbitrary data the user can attach to the object", "type": "object" } }, "required": [ "amount", "counterparty_id", "account_id", "id" ] } } }, "description": "The wire to create", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "10300.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "error": null, "id": "wire_1029384756", "imad": { "parsed": { "cycle_date": "20220719", "input_sequence_number": "999999", "input_source": "ABCDEFG" }, "unparsed": "20220719ABCDEFG999999" }, "instructions": null, "intermediary": null, "omad": { "parsed": { "cycle_date": "20220719", "frb_application_id": "FT01", "output_date": "0102", "output_destination": "MMQFMPTQ", "output_sequence_number": "000106", "output_time": "1030" }, "unparsed": "20170102MMQFMPTQ00010601021030FT01" }, "status": "pending", "uetr": "97ed4827-7b6f-4485-ad6c-2eb05c0e2a1c", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "chips_ssn": { "description": "Optional value for Chips SSN", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "error": { "description": "Error message describing why a wire failed", "type": "string" }, "fx_quote": { "description": "Associated foreign exchange quote, if any. Only present for wires at some bank partners.", "properties": { "base_currency": { "description": "Starting currency for the foreign exchange quote", "type": "string" }, "rate": { "format": "float", "type": "number" }, "status": { "description": "Status of the foreign exchange quote", "type": "string" }, "target_currency": { "description": "Target currency for the foreign exchange quote", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "imad": { "description": "Optional Input Message Accountability Data. An ID often filled out by the banks, originating from fed processing", "properties": { "parsed": { "description": "Parsed IMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "input_sequence_number": { "description": "A 6 digit number assigned for uniqueness", "type": "string" }, "input_source": { "description": "8 Alpha or Alpha-Numeric characters identifying the source", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "instructions": { "description": "Optional instructions for the recipient (maximum of 140 characters)", "type": "string" }, "intermediary": { "description": "Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire", "properties": { "address": { "description": "Physical address of the bank", "properties": { "city": { "description": "City (max 18 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters for US, max 3 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the bank (maximum of 35 characters)", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the bank", "type": "string" } }, "type": "object" }, "omad": { "description": "Optional Output Message Accountability Data. An ID originating from fed processing, similar structure to IMAD but with more info", "properties": { "parsed": { "description": "Parsed OMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "frb_application_id": { "description": "Uniquely identifies the Fedwire Funds Service site that processed the message (i.e., FT01, FT02 or FT03)", "type": "string" }, "output_date": { "description": "4 digit MMDD. Paired with `output_time`", "type": "string" }, "output_destination": { "description": "8 Alpha or Alpha-Numeric characters identifying the destination. Comparable to the IMAD `input_source`", "type": "string" }, "output_sequence_number": { "description": "A 6 digit number assigned for uniqueness. Comparable to IMAD `input_sequence_number`", "type": "string" }, "output_time": { "description": "4 digit HHmm. Paired with `output_date`", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Output Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "purpose": { "description": "Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 35 characters, may be truncated to 16 characters for sending depending on bank)", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `error`, or `sent`. Filterable.", "type": "string" }, "target_currency_code": { "description": "Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.", "type": "string" }, "uetr": { "description": "Optional Unique End-to-end Transaction Reference. A UUID that identifies the wire end-to-end, originating from ISO 20022 processing", "type": "string" }, "userdata": { "description": "Optional arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The wire created" } }, "summary": "Create a Wire Transfer", "tags": [ "Wire" ] } }, "/wire/{id}": { "get": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "10300.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "error": null, "id": "wire_1029384756", "imad": { "parsed": { "cycle_date": "20220719", "input_sequence_number": "999999", "input_source": "ABCDEFG" }, "unparsed": "20220719ABCDEFG999999" }, "instructions": null, "intermediary": null, "omad": { "parsed": { "cycle_date": "20220719", "frb_application_id": "FT01", "output_date": "0102", "output_destination": "MMQFMPTQ", "output_sequence_number": "000106", "output_time": "1030" }, "unparsed": "20170102MMQFMPTQ00010601021030FT01" }, "status": "pending", "uetr": "97ed4827-7b6f-4485-ad6c-2eb05c0e2a1c", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "chips_ssn": { "description": "Optional value for Chips SSN", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "error": { "description": "Error message describing why a wire failed", "type": "string" }, "fx_quote": { "description": "Associated foreign exchange quote, if any. Only present for wires at some bank partners.", "properties": { "base_currency": { "description": "Starting currency for the foreign exchange quote", "type": "string" }, "rate": { "format": "float", "type": "number" }, "status": { "description": "Status of the foreign exchange quote", "type": "string" }, "target_currency": { "description": "Target currency for the foreign exchange quote", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "imad": { "description": "Optional Input Message Accountability Data. An ID often filled out by the banks, originating from fed processing", "properties": { "parsed": { "description": "Parsed IMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "input_sequence_number": { "description": "A 6 digit number assigned for uniqueness", "type": "string" }, "input_source": { "description": "8 Alpha or Alpha-Numeric characters identifying the source", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "instructions": { "description": "Optional instructions for the recipient (maximum of 140 characters)", "type": "string" }, "intermediary": { "description": "Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire", "properties": { "address": { "description": "Physical address of the bank", "properties": { "city": { "description": "City (max 18 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters for US, max 3 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the bank (maximum of 35 characters)", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the bank", "type": "string" } }, "type": "object" }, "omad": { "description": "Optional Output Message Accountability Data. An ID originating from fed processing, similar structure to IMAD but with more info", "properties": { "parsed": { "description": "Parsed OMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "frb_application_id": { "description": "Uniquely identifies the Fedwire Funds Service site that processed the message (i.e., FT01, FT02 or FT03)", "type": "string" }, "output_date": { "description": "4 digit MMDD. Paired with `output_time`", "type": "string" }, "output_destination": { "description": "8 Alpha or Alpha-Numeric characters identifying the destination. Comparable to the IMAD `input_source`", "type": "string" }, "output_sequence_number": { "description": "A 6 digit number assigned for uniqueness. Comparable to IMAD `input_sequence_number`", "type": "string" }, "output_time": { "description": "4 digit HHmm. Paired with `output_date`", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Output Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "purpose": { "description": "Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 35 characters, may be truncated to 16 characters for sending depending on bank)", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `error`, or `sent`. Filterable.", "type": "string" }, "target_currency_code": { "description": "Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.", "type": "string" }, "uetr": { "description": "Optional Unique End-to-end Transaction Reference. A UUID that identifies the wire end-to-end, originating from ISO 20022 processing", "type": "string" }, "userdata": { "description": "Optional arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The wire" } }, "summary": "Fetch a Wire Transfer", "tags": [ "Wire" ] }, "patch": { "parameters": [ { "description": "Unique identifier for object", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier for object", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "example": { "summary": "Canceling a wire transfer", "value": { "status": "canceled" } } }, "schema": { "properties": { "status": { "description": "New status for wire, one of: `canceled`", "type": "string" }, "userdata": { "description": "Arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The wire to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "example": { "summary": "Success", "value": { "account_id": "acct_1234567890", "amount": "10300.00", "counterparty_id": "cp_0987654321", "created_at": "2017-11-02T11:55:14Z", "error": null, "id": "wire_1029384756", "imad": { "parsed": { "cycle_date": "20220719", "input_sequence_number": "999999", "input_source": "ABCDEFG" }, "unparsed": "20220719ABCDEFG999999" }, "instructions": null, "intermediary": null, "omad": { "parsed": { "cycle_date": "20220719", "frb_application_id": "FT01", "output_date": "0102", "output_destination": "MMQFMPTQ", "output_sequence_number": "000106", "output_time": "1030" }, "unparsed": "20170102MMQFMPTQ00010601021030FT01" }, "status": "canceled", "uetr": "97ed4827-7b6f-4485-ad6c-2eb05c0e2a1c", "updated_at": "2017-11-02T11:55:14Z", "userdata": null } } }, "schema": { "properties": { "account_id": { "description": "ID of the Account originating the transfer. Filterable.", "type": "string" }, "amount": { "description": "Amount of money to transfer, with two decimal precision", "pattern": "^-?[0-9]+[.][0-9][0-9]$", "type": "string" }, "bankdata": { "description": "Optional arbitrary data the bank can attach to the object", "type": "object" }, "chips_ssn": { "description": "Optional value for Chips SSN", "type": "string" }, "counterparty_id": { "description": "ID of the Counterparty receiving the transfer. Be sure that the wire section of the Counterparty contains non-null values. Filterable.", "type": "string" }, "error": { "description": "Error message describing why a wire failed", "type": "string" }, "fx_quote": { "description": "Associated foreign exchange quote, if any. Only present for wires at some bank partners.", "properties": { "base_currency": { "description": "Starting currency for the foreign exchange quote", "type": "string" }, "rate": { "format": "float", "type": "number" }, "status": { "description": "Status of the foreign exchange quote", "type": "string" }, "target_currency": { "description": "Target currency for the foreign exchange quote", "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier for object", "type": "string" }, "imad": { "description": "Optional Input Message Accountability Data. An ID often filled out by the banks, originating from fed processing", "properties": { "parsed": { "description": "Parsed IMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "input_sequence_number": { "description": "A 6 digit number assigned for uniqueness", "type": "string" }, "input_source": { "description": "8 Alpha or Alpha-Numeric characters identifying the source", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Input Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "instructions": { "description": "Optional instructions for the recipient (maximum of 140 characters)", "type": "string" }, "intermediary": { "description": "Optional intermediary bank information. If the recipient's bank is unable to receive a wire transfer, they will use an intermediary bank to process the wire", "properties": { "address": { "description": "Physical address of the bank", "properties": { "city": { "description": "City (max 18 characters)", "type": "string" }, "country": { "description": "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type": "string" }, "postal_code": { "description": "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type": "string" }, "state": { "description": "State (max 2 characters for US, max 3 characters for other countries)", "type": "string" }, "street_line_1": { "description": "First line of the address (max 35 characters)", "type": "string" }, "street_line_2": { "description": "Optional second line of the address (max 35 characters)", "type": "string" } }, "type": "object" }, "name": { "description": "Name of the bank (maximum of 35 characters)", "type": "string" }, "routing_number": { "description": "Valid 9-digit ABA routing transit number associated with the bank", "type": "string" } }, "type": "object" }, "omad": { "description": "Optional Output Message Accountability Data. An ID originating from fed processing, similar structure to IMAD but with more info", "properties": { "parsed": { "description": "Parsed OMAD sub-object", "properties": { "cycle_date": { "description": "Wire transfer date. YYYYMMDD", "type": "string" }, "frb_application_id": { "description": "Uniquely identifies the Fedwire Funds Service site that processed the message (i.e., FT01, FT02 or FT03)", "type": "string" }, "output_date": { "description": "4 digit MMDD. Paired with `output_time`", "type": "string" }, "output_destination": { "description": "8 Alpha or Alpha-Numeric characters identifying the destination. Comparable to the IMAD `input_source`", "type": "string" }, "output_sequence_number": { "description": "A 6 digit number assigned for uniqueness. Comparable to IMAD `input_sequence_number`", "type": "string" }, "output_time": { "description": "4 digit HHmm. Paired with `output_date`", "type": "string" } }, "type": "object" }, "unparsed": { "description": "Output Message Accountability Data: a unique number assigned to a wire transfer processed through the Federal Reserve Bank’s FedwireService", "type": "string" } }, "type": "object" }, "org_id": { "description": "ID of the organization with which this object is associated. Filterable.", "type": "string" }, "purpose": { "description": "Optional string identifying the reason for why these funds are being transferred. For example Payroll, Tuition, Travel, etc. Required if sending an international wire (maximum of 35 characters, may be truncated to 16 characters for sending depending on bank)", "type": "string" }, "status": { "description": "One of `pending`, `canceled`, `error`, or `sent`. Filterable.", "type": "string" }, "target_currency_code": { "description": "Currency code for the target currency of a foreign exchange quote. Only present for wires at some bank partners.", "type": "string" }, "uetr": { "description": "Optional Unique End-to-end Transaction Reference. A UUID that identifies the wire end-to-end, originating from ISO 20022 processing", "type": "string" }, "userdata": { "description": "Optional arbitrary data the user can attach to the object", "type": "object" } } } } }, "description": "The wire updated" } }, "summary": "Update a Wire Transfer", "tags": [ "Wire" ] } } }, "security": [ { "basicAuth": [] }, { "apiKey": [] } ], "servers": [ { "description": "Production", "url": "https://api.treasuryprime.com" }, { "description": "Sandbox", "url": "https://api.sandbox.treasuryprime.com" } ] }