{ "components": { "responses": { "errorResponse": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error" } ] } } }, "description": "Error" } }, "schemas": { "account": { "additionalProperties": true, "description": "Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.", "example": { "account_revenue_rate": null, "bank": "first_internet_bank", "closed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "funding": "deposits", "id": "account_in71c4amph0vgo2qllky", "idempotency_key": null, "informational_entity_id": null, "interest_rate": "0.055", "loan": null, "name": "My first account!", "program_id": "program_i2v2os4mwza1oetokh9i", "status": "open", "type": "account" }, "properties": { "account_revenue_rate": { "description": "The account revenue rate currently being earned on the account, as a string containing a decimal number. For example, a 1% account revenue rate would be represented as \"0.01\". Account revenue is a type of non-interest income accrued on the account.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "bank": { "description": "The bank the Account is with.", "enum": [ "core_bank", "first_internet_bank", "grasshopper_bank" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Core Bank", "First Internet Bank of Indiana", "Grasshopper Bank" ] }, "closed_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was closed.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "entity_id": { "description": "The identifier for the Entity the Account belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "funding": { "description": "Whether the Account is funded by a loan or by deposits.", "enum": [ "loan", "deposits" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An account funded by a loan. Before opening a loan account, contact support@increase.com to set up a loan program.", "An account funded by deposits." ] }, "id": { "description": "The Account identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "informational_entity_id": { "description": "The identifier of an Entity that, while not owning the Account, is associated with its activity.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities", "nullable": true }, "interest_rate": { "description": "The interest rate currently being earned on the account, as a string containing a decimal number. For example, a 1% interest rate would be represented as \"0.01\".", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "loan": { "additionalProperties": false, "description": "The Account's loan-related information, if the Account is a loan account.", "properties": { "credit_limit": { "description": "The maximum amount of money that can be borrowed on the Account.", "type": "integer", "x-documentation-priority": "default" }, "grace_period_days": { "description": "The number of days after the statement date that the Account can be past due before being considered delinquent.", "type": "integer", "x-documentation-priority": "default" }, "maturity_date": { "description": "The date on which the loan matures.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "statement_day_of_month": { "description": "The day of the month on which the loan statement is generated.", "type": "integer", "x-documentation-priority": "default" }, "statement_payment_type": { "description": "The type of payment for the loan.", "enum": [ "balance", "interest_until_maturity" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The borrower must pay the full balance of the loan at the end of the statement period.", "The borrower must pay the accrued interest at the end of the statement period." ] } }, "required": [ "credit_limit", "grace_period_days", "maturity_date", "statement_payment_type", "statement_day_of_month" ], "title": "Account Loan", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Loans", "nullable": true }, "name": { "description": "The name you choose for the Account.", "type": "string", "x-documentation-priority": "default" }, "program_id": { "description": "The identifier of the Program determining the compliance and commercial terms of this Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" }, "status": { "description": "The status of the Account.", "enum": [ "closed", "open" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Closed Accounts on which no new activity can occur.", "Open Accounts that are ready to use." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `account`.", "enum": [ "account" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "bank", "created_at", "loan", "closed_at", "currency", "entity_id", "funding", "informational_entity_id", "id", "program_id", "interest_rate", "account_revenue_rate", "name", "status", "idempotency_key" ], "title": "Account", "type": "object", "x-event-categories": [ "account.created", "account.updated" ], "x-tag": "Accounts", "x-title-plural": "Accounts" }, "account_list": { "additionalProperties": true, "description": "A list of Account objects.", "example": { "data": [ { "account_revenue_rate": null, "bank": "first_internet_bank", "closed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "funding": "deposits", "id": "account_in71c4amph0vgo2qllky", "idempotency_key": null, "informational_entity_id": null, "interest_rate": "0.055", "loan": null, "name": "My first account!", "program_id": "program_i2v2os4mwza1oetokh9i", "status": "open", "type": "account" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/account" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Account List", "type": "object", "x-event-categories": [], "x-title-plural": "Account Lists" }, "account_number": { "additionalProperties": true, "description": "Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "created_at": "2020-01-31T23:59:59Z", "id": "account_number_v18nkfqm6afpsrvy82b2", "idempotency_key": null, "inbound_ach": { "debit_status": "blocked" }, "inbound_checks": { "status": "check_transfers_only" }, "name": "ACH", "routing_number": "101050001", "status": "active", "type": "account_number" }, "properties": { "account_id": { "description": "The identifier for the account this Account Number belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The account number.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Number was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Account Number identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "inbound_ach": { "additionalProperties": false, "description": "Properties related to how this Account Number handles inbound ACH transfers.", "properties": { "debit_status": { "description": "Whether ACH debits are allowed against this Account Number. Note that they will still be declined if this is `allowed` if the Account Number is not active.", "enum": [ "allowed", "blocked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "ACH Debits are allowed.", "ACH Debits are blocked." ] } }, "required": [ "debit_status" ], "title": "Account Number InboundACH", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "InboundAchs" }, "inbound_checks": { "additionalProperties": false, "description": "Properties related to how this Account Number should handle inbound check withdrawals.", "properties": { "status": { "description": "How Increase should process checks with this account number printed on them.", "enum": [ "allowed", "check_transfers_only" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Checks with this Account Number will be processed even if they are not associated with a Check Transfer.", "Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer." ] } }, "required": [ "status" ], "title": "Account Number InboundChecks", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "InboundChecks" }, "name": { "description": "The name you choose for the Account Number.", "type": "string", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "status": { "description": "This indicates if payments can be made to the Account Number.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is active.", "The account number is temporarily disabled.", "The account number is permanently disabled." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `account_number`.", "enum": [ "account_number" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "account_number", "id", "created_at", "name", "routing_number", "status", "inbound_ach", "inbound_checks", "idempotency_key" ], "title": "Account Number", "type": "object", "x-event-categories": [ "account_number.created", "account_number.updated" ], "x-tag": "Account Numbers", "x-title-plural": "Account Numbers" }, "account_number_list": { "additionalProperties": true, "description": "A list of Account Number objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "created_at": "2020-01-31T23:59:59Z", "id": "account_number_v18nkfqm6afpsrvy82b2", "idempotency_key": null, "inbound_ach": { "debit_status": "blocked" }, "inbound_checks": { "status": "check_transfers_only" }, "name": "ACH", "routing_number": "101050001", "status": "active", "type": "account_number" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/account_number" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Account Number List", "type": "object", "x-event-categories": [], "x-title-plural": "Account Number Lists" }, "account_statement": { "additionalProperties": false, "description": "Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "ending_balance": 100, "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "account_statement_lkc03a4skm2k7f38vj15", "loan": null, "starting_balance": 0, "statement_period_end": "2020-01-31T23:59:59Z", "statement_period_start": "2020-01-31T23:59:59Z", "type": "account_statement" }, "properties": { "account_id": { "description": "The identifier for the Account this Account Statement belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "ending_balance": { "description": "The Account's balance at the end of its statement period.", "type": "integer", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing a PDF of the statement.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "id": { "description": "The Account Statement identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Statements" }, "loan": { "additionalProperties": false, "description": "The loan balances.", "properties": { "due_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan payment is due.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "due_balance": { "description": "The total amount due on the loan.", "type": "integer", "x-documentation-priority": "default" }, "past_due_balance": { "description": "The amount past due on the loan.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "due_balance", "past_due_balance", "due_at" ], "title": "Account Statement Loan", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Loans", "nullable": true }, "starting_balance": { "description": "The Account's balance at the start of its statement period.", "type": "integer", "x-documentation-priority": "default" }, "statement_period_end": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "statement_period_start": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `account_statement`.", "enum": [ "account_statement" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "account_id", "created_at", "file_id", "statement_period_start", "statement_period_end", "starting_balance", "ending_balance", "loan" ], "title": "Account Statement", "type": "object", "x-event-categories": [ "account_statement.created" ], "x-tag": "Account Statements", "x-title-plural": "Account Statements" }, "account_statement_list": { "additionalProperties": true, "description": "A list of Account Statement objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "ending_balance": 100, "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "account_statement_lkc03a4skm2k7f38vj15", "loan": null, "starting_balance": 0, "statement_period_end": "2020-01-31T23:59:59Z", "statement_period_start": "2020-01-31T23:59:59Z", "type": "account_statement" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/account_statement" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Account Statement List", "type": "object", "x-event-categories": [], "x-title-plural": "Account Statement Lists" }, "account_transfer": { "additionalProperties": true, "description": "Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).", "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "description": "Move money into savings", "destination_account_id": "account_uf16sut2ct5bevmq3eh", "destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4", "id": "account_transfer_7k9qe1ysdgqztnt63l7n", "idempotency_key": null, "pending_transaction_id": null, "status": "complete", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "account_transfer" }, "properties": { "account_id": { "description": "The Account from which the transfer originated.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.", "type": "integer", "x-documentation-priority": "default" }, "approval": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.", "example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "properties": { "approved_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "approved_by": { "description": "If the Transfer was approved by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "approved_at", "approved_by" ], "title": "Account Transfer Transfer Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Approvals", "nullable": true }, "cancellation": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.", "example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null }, "properties": { "canceled_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "canceled_by": { "description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "canceled_by" ], "title": "Account Transfer Transfer Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Cancellations", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Account Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Account Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Account Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Account Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "description": { "description": "An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.", "type": "string", "x-documentation-priority": "default" }, "destination_account_id": { "description": "The destination Account's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "destination_transaction_id": { "description": "The identifier of the Transaction on the destination Account representing the received funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "id": { "description": "The Account Transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "canceled", "complete" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending approval from your team.", "The transfer was pending approval from your team and has been canceled.", "The transfer has been completed." ] }, "transaction_id": { "description": "The identifier of the Transaction on the originating account representing the transferred funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `account_transfer`.", "enum": [ "account_transfer" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "amount", "account_id", "currency", "destination_account_id", "destination_transaction_id", "created_at", "description", "status", "transaction_id", "pending_transaction_id", "approval", "cancellation", "created_by", "idempotency_key" ], "title": "Account Transfer", "type": "object", "x-event-categories": [ "account_transfer.created", "account_transfer.updated" ], "x-tag": "Account Transfers", "x-title-plural": "Account Transfers" }, "account_transfer_list": { "additionalProperties": true, "description": "A list of Account Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "description": "Move money into savings", "destination_account_id": "account_uf16sut2ct5bevmq3eh", "destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4", "id": "account_transfer_7k9qe1ysdgqztnt63l7n", "idempotency_key": null, "pending_transaction_id": null, "status": "complete", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "account_transfer" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/account_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Account Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Account Transfer Lists" }, "ach_decline": { "additionalProperties": true, "example": { "amount": 1750, "id": "ach_decline_72v1mcwxudctq56efipa", "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "reason": "insufficient_funds", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "type": "ach_decline" }, "properties": { "amount": { "description": "The declined amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "id": { "description": "The ACH Decline's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Declines" }, "inbound_ach_transfer_id": { "description": "The identifier of the Inbound ACH Transfer object associated with this decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" }, "originator_company_descriptive_date": { "description": "The descriptive date of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_company_discretionary_data": { "description": "The additional information included with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_company_id": { "description": "The identifier of the company that initiated the transfer.", "type": "string", "x-documentation-priority": "default" }, "originator_company_name": { "description": "The name of the company that initiated the transfer.", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Why the ACH transfer was declined.", "enum": [ "ach_route_canceled", "ach_route_disabled", "breaches_limit", "entity_not_active", "group_locked", "transaction_not_allowed", "returned_per_odfi_request", "user_initiated", "insufficient_funds", "authorization_revoked_by_customer", "payment_stopped", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "beneficiary_or_account_holder_deceased", "credit_entry_refused_by_receiver", "duplicate_entry", "corporate_customer_advised_not_authorized" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "The transaction would cause an Increase limit to be exceeded.", "The account's entity is not active.", "Your account is inactive.", "The transaction is not allowed per Increase's terms.", "The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.", "Your integration declined this transfer via the API.", "Your account contains insufficient funds.", "The customer no longer authorizes this transaction.", "The customer asked for the payment to be stopped.", "The customer advises that the debit was unauthorized.", "The payee is deceased.", "The account holder is deceased.", "The customer refused a credit entry.", "The account holder identified this transaction as a duplicate.", "The corporate customer no longer authorizes this transaction." ] }, "receiver_id_number": { "description": "The id of the receiver of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_name": { "description": "The name of the receiver of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "The trace number of the transfer.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `ach_decline`.", "enum": [ "ach_decline" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "amount", "originator_company_name", "originator_company_descriptive_date", "originator_company_discretionary_data", "originator_company_id", "reason", "receiver_id_number", "receiver_name", "trace_number", "inbound_ach_transfer_id" ], "title": "ACH Decline", "type": "object", "x-event-categories": [], "x-title-plural": "ACH Declines" }, "ach_prenotification": { "additionalProperties": false, "description": "ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).", "example": { "account_id": null, "account_number": "987654321", "addendum": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_name": null, "created_at": "2020-01-31T23:59:59Z", "credit_debit_indicator": null, "effective_date": null, "id": "ach_prenotification_ubjf9qqsxl3obbcn1u34", "idempotency_key": null, "individual_id": null, "individual_name": null, "notifications_of_change": [], "prenotification_return": null, "routing_number": "101050001", "standard_entry_class_code": null, "status": "submitted", "type": "ach_prenotification" }, "properties": { "account_id": { "description": "The account that sent the ACH Prenotification.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true }, "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "addendum": { "description": "Additional information for the recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_descriptive_date": { "description": "The description of the date of the notification.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_discretionary_data": { "description": "Optional data associated with the notification.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_entry_description": { "description": "The description of the notification.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_name": { "description": "The name by which you know the company.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the prenotification was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "credit_debit_indicator": { "description": "If the notification is for a future credit or debit.", "enum": [ "credit", "debit" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Prenotification is for an anticipated credit.", "The Prenotification is for an anticipated debit." ], "nullable": true }, "effective_date": { "description": "The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The ACH Prenotification's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Prenotifications" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "individual_id": { "description": "Your identifier for the recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "individual_name": { "description": "The name of the recipient. This value is informational and not verified by the recipient's bank.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "notifications_of_change": { "description": "If the receiving bank notifies that future transfers should use different details, this will contain those details.", "items": { "additionalProperties": false, "example": { "change_code": "incorrect_transaction_code", "corrected_data": "32", "created_at": "2020-01-31T23:59:59Z" }, "properties": { "change_code": { "description": "The required type of change that is being signaled by the receiving financial institution.", "enum": [ "incorrect_account_number", "incorrect_routing_number", "incorrect_routing_number_and_account_number", "incorrect_transaction_code", "incorrect_account_number_and_transaction_code", "incorrect_routing_number_account_number_and_transaction_code", "incorrect_receiving_depository_financial_institution_identification", "incorrect_individual_identification_number", "addenda_format_error", "incorrect_standard_entry_class_code_for_outbound_international_payment", "misrouted_notification_of_change", "incorrect_trace_number", "incorrect_company_identification_number", "incorrect_identification_number", "incorrectly_formatted_corrected_data", "incorrect_discretionary_data", "routing_number_not_from_original_entry_detail_record", "depository_financial_institution_account_number_not_from_original_entry_detail_record", "incorrect_transaction_code_by_originating_depository_financial_institution" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number was incorrect.", "The routing number was incorrect.", "Both the routing number and the account number were incorrect.", "The transaction code was incorrect. Try changing the `funding` parameter from checking to savings or vice-versa.", "The account number and the transaction code were incorrect.", "The routing number, account number, and transaction code were incorrect.", "The receiving depository financial institution identification was incorrect.", "The individual identification number was incorrect.", "The addenda had an incorrect format.", "The standard entry class code was incorrect for an outbound international payment.", "The notification of change was misrouted.", "The trace number was incorrect.", "The company identification number was incorrect.", "The individual identification number or identification number was incorrect.", "The corrected data was incorrectly formatted.", "The discretionary data was incorrect.", "The routing number was not from the original entry detail record.", "The depository financial institution account number was not from the original entry detail record.", "The transaction code was incorrect, initiated by the originating depository financial institution." ] }, "corrected_data": { "description": "The corrected data that should be used in future ACHs to this account. This may contain the suggested new account number or routing number. When the `change_code` is `incorrect_transaction_code`, this field contains an integer. Numbers starting with a 2 encourage changing the `funding` parameter to checking; numbers starting with a 3 encourage changing to savings.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the notification occurred.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "created_at", "change_code", "corrected_data" ], "title": "ACH Prenotification ACH Notification of Change", "type": "object", "x-event-categories": [], "x-title-plural": "ACH Notifications of change" }, "type": "array", "x-documentation-priority": "default" }, "prenotification_return": { "additionalProperties": false, "description": "If your prenotification is returned, this will contain details of the return.", "example": { "created_at": "2020-01-31T23:59:59Z", "return_reason_code": "corporate_customer_advised_not_authorized" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Prenotification was returned.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "return_reason_code": { "description": "Why the Prenotification was returned.", "enum": [ "insufficient_fund", "no_account", "account_closed", "invalid_account_number_structure", "account_frozen_entry_returned_per_ofac_instruction", "credit_entry_refused_by_receiver", "unauthorized_debit_to_consumer_account_using_corporate_sec_code", "corporate_customer_advised_not_authorized", "payment_stopped", "non_transaction_account", "uncollected_funds", "routing_number_check_digit_error", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "amount_field_error", "authorization_revoked_by_customer", "invalid_ach_routing_number", "file_record_edit_criteria", "enr_invalid_individual_name", "returned_per_odfi_request", "limited_participation_dfi", "incorrectly_coded_outbound_international_payment", "account_sold_to_another_dfi", "addenda_error", "beneficiary_or_account_holder_deceased", "customer_advised_not_within_authorization_terms", "corrected_return", "duplicate_entry", "duplicate_return", "enr_duplicate_enrollment", "enr_invalid_dfi_account_number", "enr_invalid_individual_id_number", "enr_invalid_representative_payee_indicator", "enr_invalid_transaction_code", "enr_return_of_enr_entry", "enr_routing_number_check_digit_error", "entry_not_processed_by_gateway", "field_error", "foreign_receiving_dfi_unable_to_settle", "iat_entry_coding_error", "improper_effective_entry_date", "improper_source_document_source_document_presented", "invalid_company_id", "invalid_foreign_receiving_dfi_identification", "invalid_individual_id_number", "item_and_rck_entry_presented_for_payment", "item_related_to_rck_entry_is_ineligible", "mandatory_field_error", "misrouted_dishonored_return", "misrouted_return", "no_errors_found", "non_acceptance_of_r62_dishonored_return", "non_participant_in_iat_program", "permissible_return_entry", "permissible_return_entry_not_accepted", "rdfi_non_settlement", "rdfi_participant_in_check_truncation_program", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "return_not_a_duplicate", "return_of_erroneous_or_reversing_debit", "return_of_improper_credit_entry", "return_of_improper_debit_entry", "return_of_xck_entry", "source_document_presented_for_payment", "state_law_affecting_rck_acceptance", "stop_payment_on_item_related_to_rck_entry", "stop_payment_on_source_document", "timely_original_return", "trace_number_error", "untimely_dishonored_return", "untimely_return" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to \"NSF.\"", "Code R03. The account does not exist or the receiving bank was unable to locate it.", "Code R02. The account is closed at the receiving bank.", "Code R04. The account number is invalid at the receiving bank.", "Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.", "Code R23. The receiving bank refused the credit transfer.", "Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.", "Code R29. The corporate customer at the receiving bank reversed the transfer.", "Code R08. The receiving bank stopped payment on this transfer.", "Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.", "Code R09. The receiving bank account does not have enough available balance for the transfer.", "Code R28. The routing number is incorrect.", "Code R10. The customer at the receiving bank reversed the transfer.", "Code R19. The amount field is incorrect or too large.", "Code R07. The customer revoked their authorization for a previously authorized transfer.", "Code R13. The routing number is invalid.", "Code R17. The receiving bank is unable to process a field in the transfer.", "Code R45. A rare return reason. The individual name field was invalid.", "Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.", "Code R34. The receiving bank's regulatory supervisor has limited their participation in the ACH network.", "Code R85. The outbound international ACH transfer was incorrect.", "Code R12. A rare return reason. The account was sold to another bank.", "Code R25. The addenda record is incorrect or missing.", "Code R15. A rare return reason. The account holder is deceased.", "Code R11. A rare return reason. The customer authorized some payment to the sender, but this payment was not in error.", "Code R74. A rare return reason. Sent in response to a return that was returned with code `field_error`. The latest return should include the corrected field(s).", "Code R24. A rare return reason. The receiving bank received an exact duplicate entry with the same trace number and amount.", "Code R67. A rare return reason. The return this message refers to was a duplicate.", "Code R47. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R43. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R44. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R46. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R41. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R40. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R42. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R84. A rare return reason. The International ACH Transfer cannot be processed by the gateway.", "Code R69. A rare return reason. One or more of the fields in the ACH were malformed.", "Code R83. A rare return reason. The Foreign receiving bank was unable to settle this ACH transfer.", "Code R80. A rare return reason. The International ACH Transfer is malformed.", "Code R18. A rare return reason. The ACH has an improper effective entry date field.", "Code R39. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R21. A rare return reason. The Company ID field of the ACH was invalid.", "Code R82. A rare return reason. The foreign receiving bank identifier for an International ACH Transfer was invalid.", "Code R22. A rare return reason. The Individual ID number field of the ACH was invalid.", "Code R53. A rare return reason. Both the Represented Check (\"RCK\") entry and the original check were presented to the bank.", "Code R51. A rare return reason. The Represented Check (\"RCK\") entry is ineligible.", "Code R26. A rare return reason. The ACH is missing a required field.", "Code R71. A rare return reason. The receiving bank does not recognize the routing number in a dishonored return entry.", "Code R61. A rare return reason. The receiving bank does not recognize the routing number in a return entry.", "Code R76. A rare return reason. Sent in response to a return, the bank does not find the errors alleged by the returning bank.", "Code R77. A rare return reason. The receiving bank does not accept the return of the erroneous debit. The funds are not available at the receiving bank.", "Code R81. A rare return reason. The receiving bank does not accept International ACH Transfers.", "Code R31. A rare return reason. A return that has been agreed to be accepted by the receiving bank, despite falling outside of the usual return timeframe.", "Code R70. A rare return reason. The receiving bank had not approved this return.", "Code R32. A rare return reason. The receiving bank could not settle this transaction.", "Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers.", "Code R14. A rare return reason. The payee is deceased.", "Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate.", "Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it.", "Code R36. A rare return reason. Return of a malformed credit entry.", "Code R35. A rare return reason. Return of a malformed debit entry.", "Code R33. A rare return reason. Return of a destroyed check (\"XCK\") entry.", "Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check (\"RCK\") entry.", "Code R52. A rare return reason. A stop payment was issued on a Represented Check (\"RCK\") entry.", "Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment.", "Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time.", "Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH.", "Code R72. A rare return reason. The dishonored return was sent too late.", "Code R68. A rare return reason. The return was sent too late." ] } }, "required": [ "created_at", "return_reason_code" ], "title": "ACH Prenotification ACH Prenotification Return", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Prenotification Returns", "nullable": true }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "standard_entry_class_code": { "description": "The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the ACH Prenotification.", "enum": [ "corporate_credit_or_debit", "corporate_trade_exchange", "prearranged_payments_and_deposit", "internet_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Corporate Credit and Debit (CCD) is used for business-to-business payments.", "Corporate Trade Exchange (CTX) allows for including extensive remittance information with business-to-business payments.", "Prearranged Payments and Deposits (PPD) is used for credits or debits originated by an organization to a consumer, such as payroll direct deposits.", "Internet Initiated (WEB) is used for consumer payments initiated or authorized via the Internet. Debits can only be initiated by non-consumers to debit a consumer’s account. Credits can only be used for consumer to consumer transactions." ], "nullable": true }, "status": { "description": "The lifecycle status of the ACH Prenotification.", "enum": [ "pending_submitting", "requires_attention", "returned", "submitted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Prenotification is pending submission.", "The Prenotification requires attention.", "The Prenotification has been returned.", "The Prenotification is complete." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `ach_prenotification`.", "enum": [ "ach_prenotification" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "account_id", "account_number", "addendum", "company_descriptive_date", "company_discretionary_data", "company_entry_description", "company_name", "credit_debit_indicator", "effective_date", "routing_number", "prenotification_return", "notifications_of_change", "created_at", "status", "individual_id", "individual_name", "standard_entry_class_code", "idempotency_key" ], "title": "ACH Prenotification", "type": "object", "x-event-categories": [ "ach_prenotification.created", "ach_prenotification.updated" ], "x-tag": "ACH Prenotifications", "x-title-plural": "ACH Prenotifications" }, "ach_prenotification_list": { "additionalProperties": true, "description": "A list of ACH Prenotification objects.", "example": { "data": [ { "account_id": null, "account_number": "987654321", "addendum": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_name": null, "created_at": "2020-01-31T23:59:59Z", "credit_debit_indicator": null, "effective_date": null, "id": "ach_prenotification_ubjf9qqsxl3obbcn1u34", "idempotency_key": null, "individual_id": null, "individual_name": null, "notifications_of_change": [], "prenotification_return": null, "routing_number": "101050001", "standard_entry_class_code": null, "status": "submitted", "type": "ach_prenotification" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/ach_prenotification" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "ACH Prenotification List", "type": "object", "x-event-categories": [], "x-title-plural": "ACH Prenotification Lists" }, "ach_transfer": { "additionalProperties": true, "description": "ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "addenda": null, "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_id": "1234987601", "company_name": "National Phonograph Company", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "destination_account_holder": "business", "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "funding": "checking", "id": "ach_transfer_uoxatyh3lt5evrsdvo7q", "idempotency_key": null, "inbound_funds_hold": null, "individual_id": null, "individual_name": "Ian Crease", "network": "ach", "notifications_of_change": [], "pending_transaction_id": null, "preferred_effective_date": { "date": null, "settlement_schedule": "same_day" }, "return": null, "routing_number": "101050001", "settlement": null, "standard_entry_class_code": "corporate_credit_or_debit", "statement_descriptor": "Statement descriptor", "status": "returned", "submission": { "administrative_returns_expected_by": "2020-02-05T11:00:00Z", "effective_date": "2020-01-31", "expected_funds_settlement_at": "2020-02-03T13:30:00Z", "expected_settlement_schedule": "future_dated", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "058349238292834" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "ach_transfer" }, "properties": { "account_id": { "description": "The Account to which the transfer belongs.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "acknowledgement": { "additionalProperties": false, "description": "After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.", "example": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "properties": { "acknowledged_at": { "description": "When the Federal Reserve acknowledged the submitted file containing this transfer.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "acknowledged_at" ], "title": "ACH Transfer ACH Transfer Acknowledgement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Acknowledgements", "nullable": true }, "addenda": { "additionalProperties": false, "description": "Additional information that will be sent to the recipient.", "example": { "category": "freeform", "freeform": { "entries": [ { "payment_related_information": "addendum" } ] } }, "properties": { "category": { "description": "The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "freeform", "payment_order_remittance_advice", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unstructured `payment_related_information` passed through with the transfer.", "Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information.", "Unknown addenda type." ] }, "freeform": { "additionalProperties": false, "description": "Unstructured `payment_related_information` passed through with the transfer.", "properties": { "entries": { "description": "Each entry represents an addendum sent with the transfer.", "items": { "additionalProperties": false, "properties": { "payment_related_information": { "description": "The payment related information passed in the addendum.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "payment_related_information" ], "title": "ACH Transfer ACH Transfer Addenda Freeform EntriesElement", "type": "object", "x-event-categories": [], "x-title-plural": "EntriesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "entries" ], "title": "ACH Transfer ACH Transfer Addenda Freeform", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Freeforms", "nullable": true }, "payment_order_remittance_advice": { "additionalProperties": false, "description": "Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information.", "properties": { "invoices": { "description": "ASC X12 RMR records for this specific transfer.", "items": { "additionalProperties": false, "properties": { "invoice_number": { "description": "The invoice number for this reference, determined in advance with the receiver.", "type": "string", "x-documentation-priority": "default" }, "paid_amount": { "description": "The amount that was paid for this invoice in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "invoice_number", "paid_amount" ], "title": "ACH Transfer ACH Transfer Addenda PaymentOrderRemittanceAdvice InvoicesElement", "type": "object", "x-event-categories": [], "x-title-plural": "InvoicesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "invoices" ], "title": "ACH Transfer ACH Transfer Addenda PaymentOrderRemittanceAdvice", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "PaymentOrderRemittanceAdvices", "nullable": true } }, "required": [ "category" ], "title": "ACH Transfer ACH Transfer Addenda", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Addendas", "nullable": true }, "amount": { "description": "The transfer amount in USD cents. A positive amount indicates a credit transfer pushing funds to the receiving account. A negative amount indicates a debit transfer pulling funds from the receiving account.", "type": "integer", "x-documentation-priority": "default" }, "approval": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.", "example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "properties": { "approved_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "approved_by": { "description": "If the Transfer was approved by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "approved_at", "approved_by" ], "title": "ACH Transfer Transfer Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Approvals", "nullable": true }, "cancellation": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.", "example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null }, "properties": { "canceled_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "canceled_by": { "description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "canceled_by" ], "title": "ACH Transfer Transfer Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Cancellations", "nullable": true }, "company_descriptive_date": { "description": "The description of the date of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_discretionary_data": { "description": "The data you chose to associate with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_entry_description": { "description": "The description of the transfer you set to be shown to the recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "company_id": { "description": "The company ID associated with the transfer.", "type": "string", "x-documentation-priority": "default" }, "company_name": { "description": "The name by which the recipient knows you.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "ACH Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "ACH Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "ACH Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "ACH Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For ACH transfers this is always equal to `usd`.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "destination_account_holder": { "description": "The type of entity that owns the account to which the ACH Transfer is being sent.", "enum": [ "business", "individual", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is owned by a business.", "The External Account is owned by an individual.", "It's unknown what kind of entity owns the External Account." ] }, "external_account_id": { "description": "The identifier of the External Account the transfer was made to, if any.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts", "nullable": true }, "funding": { "description": "The type of the account to which the transfer will be sent.", "enum": [ "checking", "savings", "general_ledger" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A checking account.", "A savings account.", "A bank's general ledger. Uncommon." ] }, "id": { "description": "The ACH transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "inbound_funds_hold": { "description": "Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_funds_hold" } ], "nullable": true }, "individual_id": { "description": "Your identifier for the transfer recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "individual_name": { "description": "The name of the transfer recipient. This value is informational and not verified by the recipient's bank.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network": { "description": "The transfer's network.", "enum": [ "ach" ], "type": "string", "x-documentation-priority": "default" }, "notifications_of_change": { "description": "If the receiving bank accepts the transfer but notifies that future transfers should use different details, this will contain those details.", "items": { "additionalProperties": false, "example": { "change_code": "incorrect_transaction_code", "corrected_data": "32", "created_at": "2020-01-31T23:59:59Z" }, "properties": { "change_code": { "description": "The required type of change that is being signaled by the receiving financial institution.", "enum": [ "incorrect_account_number", "incorrect_routing_number", "incorrect_routing_number_and_account_number", "incorrect_transaction_code", "incorrect_account_number_and_transaction_code", "incorrect_routing_number_account_number_and_transaction_code", "incorrect_receiving_depository_financial_institution_identification", "incorrect_individual_identification_number", "addenda_format_error", "incorrect_standard_entry_class_code_for_outbound_international_payment", "misrouted_notification_of_change", "incorrect_trace_number", "incorrect_company_identification_number", "incorrect_identification_number", "incorrectly_formatted_corrected_data", "incorrect_discretionary_data", "routing_number_not_from_original_entry_detail_record", "depository_financial_institution_account_number_not_from_original_entry_detail_record", "incorrect_transaction_code_by_originating_depository_financial_institution" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number was incorrect.", "The routing number was incorrect.", "Both the routing number and the account number were incorrect.", "The transaction code was incorrect. Try changing the `funding` parameter from checking to savings or vice-versa.", "The account number and the transaction code were incorrect.", "The routing number, account number, and transaction code were incorrect.", "The receiving depository financial institution identification was incorrect.", "The individual identification number was incorrect.", "The addenda had an incorrect format.", "The standard entry class code was incorrect for an outbound international payment.", "The notification of change was misrouted.", "The trace number was incorrect.", "The company identification number was incorrect.", "The individual identification number or identification number was incorrect.", "The corrected data was incorrectly formatted.", "The discretionary data was incorrect.", "The routing number was not from the original entry detail record.", "The depository financial institution account number was not from the original entry detail record.", "The transaction code was incorrect, initiated by the originating depository financial institution." ] }, "corrected_data": { "description": "The corrected data that should be used in future ACHs to this account. This may contain the suggested new account number or routing number. When the `change_code` is `incorrect_transaction_code`, this field contains an integer. Numbers starting with a 2 encourage changing the `funding` parameter to checking; numbers starting with a 3 encourage changing to savings.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the notification occurred.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "created_at", "change_code", "corrected_data" ], "title": "ACH Transfer ACH Notification of Change", "type": "object", "x-event-categories": [], "x-title-plural": "ACH Notifications of change" }, "type": "array", "x-documentation-priority": "default" }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "preferred_effective_date": { "additionalProperties": false, "description": "Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.", "properties": { "date": { "description": "A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to use as the effective date when submitting this transfer.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "settlement_schedule": { "description": "A schedule by which Increase will choose an effective date for the transfer.", "enum": [ "same_day", "future_dated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.\nThis is necessary, but not sufficient for the transfer to be settled same-day:\nit must also be submitted before the last same-day cutoff\nand be less than or equal to $1,000.000.00.\n", "The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day." ], "nullable": true } }, "required": [ "date", "settlement_schedule" ], "title": "ACH Transfer PreferredEffectiveDate", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "PreferredEffectiveDates" }, "return": { "additionalProperties": true, "description": "If your transfer is returned, this will contain details of the return.", "example": { "created_at": "2020-01-31T23:59:59Z", "raw_return_reason_code": "R01", "return_reason_code": "insufficient_fund", "trace_number": "111122223292834", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "raw_return_reason_code": { "description": "The three character ACH return code, in the range R01 to R85.", "type": "string", "x-documentation-priority": "default" }, "return_reason_code": { "description": "Why the ACH Transfer was returned. This reason code is sent by the receiving bank back to Increase.", "enum": [ "insufficient_fund", "no_account", "account_closed", "invalid_account_number_structure", "account_frozen_entry_returned_per_ofac_instruction", "credit_entry_refused_by_receiver", "unauthorized_debit_to_consumer_account_using_corporate_sec_code", "corporate_customer_advised_not_authorized", "payment_stopped", "non_transaction_account", "uncollected_funds", "routing_number_check_digit_error", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "amount_field_error", "authorization_revoked_by_customer", "invalid_ach_routing_number", "file_record_edit_criteria", "enr_invalid_individual_name", "returned_per_odfi_request", "limited_participation_dfi", "incorrectly_coded_outbound_international_payment", "account_sold_to_another_dfi", "addenda_error", "beneficiary_or_account_holder_deceased", "customer_advised_not_within_authorization_terms", "corrected_return", "duplicate_entry", "duplicate_return", "enr_duplicate_enrollment", "enr_invalid_dfi_account_number", "enr_invalid_individual_id_number", "enr_invalid_representative_payee_indicator", "enr_invalid_transaction_code", "enr_return_of_enr_entry", "enr_routing_number_check_digit_error", "entry_not_processed_by_gateway", "field_error", "foreign_receiving_dfi_unable_to_settle", "iat_entry_coding_error", "improper_effective_entry_date", "improper_source_document_source_document_presented", "invalid_company_id", "invalid_foreign_receiving_dfi_identification", "invalid_individual_id_number", "item_and_rck_entry_presented_for_payment", "item_related_to_rck_entry_is_ineligible", "mandatory_field_error", "misrouted_dishonored_return", "misrouted_return", "no_errors_found", "non_acceptance_of_r62_dishonored_return", "non_participant_in_iat_program", "permissible_return_entry", "permissible_return_entry_not_accepted", "rdfi_non_settlement", "rdfi_participant_in_check_truncation_program", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "return_not_a_duplicate", "return_of_erroneous_or_reversing_debit", "return_of_improper_credit_entry", "return_of_improper_debit_entry", "return_of_xck_entry", "source_document_presented_for_payment", "state_law_affecting_rck_acceptance", "stop_payment_on_item_related_to_rck_entry", "stop_payment_on_source_document", "timely_original_return", "trace_number_error", "untimely_dishonored_return", "untimely_return" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to \"NSF.\"", "Code R03. The account does not exist or the receiving bank was unable to locate it.", "Code R02. The account is closed at the receiving bank.", "Code R04. The account number is invalid at the receiving bank.", "Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.", "Code R23. The receiving bank refused the credit transfer.", "Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.", "Code R29. The corporate customer at the receiving bank reversed the transfer.", "Code R08. The receiving bank stopped payment on this transfer.", "Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.", "Code R09. The receiving bank account does not have enough available balance for the transfer.", "Code R28. The routing number is incorrect.", "Code R10. The customer at the receiving bank reversed the transfer.", "Code R19. The amount field is incorrect or too large.", "Code R07. The customer revoked their authorization for a previously authorized transfer.", "Code R13. The routing number is invalid.", "Code R17. The receiving bank is unable to process a field in the transfer.", "Code R45. A rare return reason. The individual name field was invalid.", "Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.", "Code R34. The receiving bank's regulatory supervisor has limited their participation in the ACH network.", "Code R85. The outbound international ACH transfer was incorrect.", "Code R12. A rare return reason. The account was sold to another bank.", "Code R25. The addenda record is incorrect or missing.", "Code R15. A rare return reason. The account holder is deceased.", "Code R11. A rare return reason. The customer authorized some payment to the sender, but this payment was not in error.", "Code R74. A rare return reason. Sent in response to a return that was returned with code `field_error`. The latest return should include the corrected field(s).", "Code R24. A rare return reason. The receiving bank received an exact duplicate entry with the same trace number and amount.", "Code R67. A rare return reason. The return this message refers to was a duplicate.", "Code R47. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R43. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R44. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R46. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R41. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R40. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R42. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R84. A rare return reason. The International ACH Transfer cannot be processed by the gateway.", "Code R69. A rare return reason. One or more of the fields in the ACH were malformed.", "Code R83. A rare return reason. The Foreign receiving bank was unable to settle this ACH transfer.", "Code R80. A rare return reason. The International ACH Transfer is malformed.", "Code R18. A rare return reason. The ACH has an improper effective entry date field.", "Code R39. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R21. A rare return reason. The Company ID field of the ACH was invalid.", "Code R82. A rare return reason. The foreign receiving bank identifier for an International ACH Transfer was invalid.", "Code R22. A rare return reason. The Individual ID number field of the ACH was invalid.", "Code R53. A rare return reason. Both the Represented Check (\"RCK\") entry and the original check were presented to the bank.", "Code R51. A rare return reason. The Represented Check (\"RCK\") entry is ineligible.", "Code R26. A rare return reason. The ACH is missing a required field.", "Code R71. A rare return reason. The receiving bank does not recognize the routing number in a dishonored return entry.", "Code R61. A rare return reason. The receiving bank does not recognize the routing number in a return entry.", "Code R76. A rare return reason. Sent in response to a return, the bank does not find the errors alleged by the returning bank.", "Code R77. A rare return reason. The receiving bank does not accept the return of the erroneous debit. The funds are not available at the receiving bank.", "Code R81. A rare return reason. The receiving bank does not accept International ACH Transfers.", "Code R31. A rare return reason. A return that has been agreed to be accepted by the receiving bank, despite falling outside of the usual return timeframe.", "Code R70. A rare return reason. The receiving bank had not approved this return.", "Code R32. A rare return reason. The receiving bank could not settle this transaction.", "Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers.", "Code R14. A rare return reason. The payee is deceased.", "Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate.", "Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it.", "Code R36. A rare return reason. Return of a malformed credit entry.", "Code R35. A rare return reason. Return of a malformed debit entry.", "Code R33. A rare return reason. Return of a destroyed check (\"XCK\") entry.", "Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check (\"RCK\") entry.", "Code R52. A rare return reason. A stop payment was issued on a Represented Check (\"RCK\") entry.", "Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment.", "Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time.", "Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH.", "Code R72. A rare return reason. The dishonored return was sent too late.", "Code R68. A rare return reason. The return was sent too late." ] }, "trace_number": { "description": "A 15 digit number that was generated by the bank that initiated the return. The trace number of the return is different than that of the original transfer. ACH trace numbers are not unique, but along with the amount and date this number can be used to identify the ACH return at the bank that initiated it.", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the Transaction associated with this return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "transfer_id": { "description": "The identifier of the ACH Transfer associated with this return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } }, "required": [ "created_at", "trace_number", "return_reason_code", "raw_return_reason_code", "transfer_id", "transaction_id" ], "title": "ACH Transfer ACH Transfer Return", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Returns", "nullable": true }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "settlement": { "additionalProperties": false, "description": "A subhash containing information about when and how the transfer settled at the Federal Reserve.", "properties": { "settled_at": { "description": "When the funds for this transfer have settled at the destination bank at the Federal Reserve.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "settled_at" ], "title": "ACH Transfer Settlement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Settlements", "nullable": true }, "standard_entry_class_code": { "description": "The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the transfer.", "enum": [ "corporate_credit_or_debit", "corporate_trade_exchange", "prearranged_payments_and_deposit", "internet_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Corporate Credit and Debit (CCD) is used for business-to-business payments.", "Corporate Trade Exchange (CTX) allows for including extensive remittance information with business-to-business payments.", "Prearranged Payments and Deposits (PPD) is used for credits or debits originated by an organization to a consumer, such as payroll direct deposits.", "Internet Initiated (WEB) is used for consumer payments initiated or authorized via the Internet. Debits can only be initiated by non-consumers to debit a consumer’s account. Credits can only be used for consumer to consumer transactions." ] }, "statement_descriptor": { "description": "The descriptor that will show on the recipient's bank statement.", "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "pending_transfer_session_confirmation", "canceled", "pending_submission", "pending_reviewing", "requires_attention", "rejected", "submitted", "returned" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer belongs to a Transfer Session that is pending confirmation.", "The transfer has been canceled.", "The transfer is pending submission to the Federal Reserve.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer has been rejected.", "The transfer is complete.", "The transfer has been returned." ] }, "submission": { "additionalProperties": false, "description": "After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).", "example": { "administrative_returns_expected_by": "2020-02-05T11:00:00Z", "effective_date": "2020-01-31", "expected_funds_settlement_at": "2020-02-03T13:30:00Z", "expected_settlement_schedule": "future_dated", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "058349238292834" }, "properties": { "administrative_returns_expected_by": { "description": "The timestamp by which any administrative returns are expected to be received by. This follows the NACHA guidelines for return windows, which are: \"In general, return entries must be received by the RDFI’s ACH Operator by its deposit deadline for the return entry to be made available to the ODFI no later than the opening of business on the second banking day following the Settlement Date of the original entry.\".", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "effective_date": { "description": "The ACH transfer's effective date as sent to the Federal Reserve. If a specific date was configured using `preferred_effective_date`, this will match that value. Otherwise, it will be the date selected (following the specified settlement schedule) at the time the transfer was submitted.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "expected_funds_settlement_at": { "description": "When the transfer is expected to settle in the recipient's account. Credits may be available sooner, at the receiving bank's discretion. The FedACH schedule is published [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "expected_settlement_schedule": { "description": "The settlement schedule the transfer is expected to follow. This expectation takes into account the `effective_date`, `submitted_at`, and the amount of the transfer.", "enum": [ "same_day", "future_dated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is expected to settle same-day.", "The transfer is expected to settle on a future date." ] }, "submitted_at": { "description": "When the ACH transfer was sent to FedACH.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "trace_number": { "description": "A 15 digit number recorded in the Nacha file and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at the receiving bank. ACH trace numbers are not unique, but are [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).", "type": "string", "x-documentation-priority": "default" } }, "required": [ "trace_number", "submitted_at", "expected_funds_settlement_at", "effective_date", "expected_settlement_schedule", "administrative_returns_expected_by" ], "title": "ACH Transfer ACH Transfer Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Submissions", "nullable": true }, "transaction_id": { "description": "The ID for the transaction funding the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `ach_transfer`.", "enum": [ "ach_transfer" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "account_number", "addenda", "amount", "currency", "approval", "cancellation", "created_at", "destination_account_holder", "external_account_id", "id", "network", "notifications_of_change", "return", "routing_number", "statement_descriptor", "status", "submission", "acknowledgement", "settlement", "inbound_funds_hold", "transaction_id", "pending_transaction_id", "company_descriptive_date", "company_discretionary_data", "company_entry_description", "company_name", "company_id", "funding", "individual_id", "individual_name", "preferred_effective_date", "standard_entry_class_code", "created_by", "idempotency_key" ], "title": "ACH Transfer", "type": "object", "x-event-categories": [ "ach_transfer.created", "ach_transfer.updated" ], "x-tag": "ACH Transfers", "x-title-plural": "ACH Transfers" }, "ach_transfer_list": { "additionalProperties": true, "description": "A list of ACH Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "addenda": null, "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_id": "1234987601", "company_name": "National Phonograph Company", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "destination_account_holder": "business", "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "funding": "checking", "id": "ach_transfer_uoxatyh3lt5evrsdvo7q", "idempotency_key": null, "inbound_funds_hold": null, "individual_id": null, "individual_name": "Ian Crease", "network": "ach", "notifications_of_change": [], "pending_transaction_id": null, "preferred_effective_date": { "date": null, "settlement_schedule": "same_day" }, "return": null, "routing_number": "101050001", "settlement": null, "standard_entry_class_code": "corporate_credit_or_debit", "statement_descriptor": "Statement descriptor", "status": "returned", "submission": { "administrative_returns_expected_by": "2020-02-05T11:00:00Z", "effective_date": "2020-01-31", "expected_funds_settlement_at": "2020-02-03T13:30:00Z", "expected_settlement_schedule": "future_dated", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "058349238292834" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "ach_transfer" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/ach_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "ACH Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "ACH Transfer Lists" }, "action_a_real_time_decision_parameters": { "additionalProperties": false, "example": { "card_authorization": { "approval": { "cardholder_address_verification_result": { "line1": "match", "postal_code": "no_match" } }, "decision": "approve" } }, "properties": { "card_authentication": { "additionalProperties": false, "description": "If the Real-Time Decision relates to a 3DS card authentication attempt, this object contains your response to the authentication.", "properties": { "decision": { "description": "Whether the card authentication attempt should be approved or declined.", "enum": [ "approve", "challenge", "deny" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the authentication attempt without triggering a challenge.", "Request further validation before approving the authentication attempt.", "Deny the authentication attempt." ] } }, "required": [ "decision" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "card_authentication_challenge": { "additionalProperties": false, "description": "If the Real-Time Decision relates to 3DS card authentication challenge delivery, this object contains your response.", "properties": { "result": { "description": "Whether the card authentication challenge was successfully delivered to the cardholder.", "enum": [ "success", "failure" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Your application successfully delivered the one-time code to the cardholder.", "Your application was unable to deliver the one-time code to the cardholder." ] }, "success": { "additionalProperties": false, "description": "If your application was able to deliver the one-time code, this contains metadata about the delivery.", "properties": { "email": { "description": "The email address that was used to deliver the one-time code to the cardholder.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "The phone number that was used to deliver the one-time code to the cardholder via SMS.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "result" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "card_authorization": { "additionalProperties": true, "description": "If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.", "properties": { "approval": { "additionalProperties": false, "description": "If your application approves the authorization, this contains metadata about your decision to approve. Your response here is advisory to the acquiring bank. The bank may choose to reverse the authorization if you approve the transaction but indicate the address does not match.", "properties": { "cardholder_address_verification_result": { "additionalProperties": false, "description": "Your decisions on whether or not each provided address component is a match. Your response here is evaluated against the customer's provided `postal_code` and `line1`, and an appropriate network response is generated. For more information, see our [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides) guide.", "properties": { "line1": { "description": "Your decision on the address line of the provided address.", "enum": [ "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder address verification result matches the address provided by the merchant.", "The cardholder address verification result does not match the address provided by the merchant." ] }, "postal_code": { "description": "Your decision on the postal code of the provided address.", "enum": [ "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder address verification result matches the address provided by the merchant.", "The cardholder address verification result does not match the address provided by the merchant." ] } }, "required": [ "line1", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "partial_amount": { "description": "If the transaction supports partial approvals (`partial_approval_capability: supported`) the `partial_amount` can be provided in the transaction's settlement currency to approve a lower amount than was requested.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "decision": { "description": "Whether the card authorization should be approved or declined.", "enum": [ "approve", "decline" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the authorization.", "Decline the authorization." ] }, "decline": { "additionalProperties": false, "description": "If your application declines the authorization, this contains details about the decline.", "properties": { "reason": { "description": "The reason the card authorization was declined. This translates to a specific decline code that is sent to the card network.", "enum": [ "insufficient_funds", "transaction_never_allowed", "exceeds_approval_limit", "card_temporarily_disabled", "suspected_fraud", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again.", "This type of transaction is not allowed for this card. This transaction should not be retried.", "The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again.", "The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again.", "The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.", "The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly." ] } }, "required": [ "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "decision" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "card_balance_inquiry": { "additionalProperties": false, "description": "If the Real-Time Decision relates to a card balance inquiry attempt, this object contains your response to the inquiry.", "properties": { "approval": { "additionalProperties": false, "description": "If your application approves the balance inquiry, this contains metadata about your decision to approve.", "properties": { "balance": { "description": "The balance on the card in the settlement currency of the transaction.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "balance" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "decision": { "description": "Whether the card balance inquiry should be approved or declined.", "enum": [ "approve", "decline" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the authorization.", "Decline the authorization." ] } }, "required": [ "decision" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "digital_wallet_authentication": { "additionalProperties": false, "description": "If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.", "properties": { "result": { "description": "Whether your application was able to deliver the one-time passcode.", "enum": [ "success", "failure" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Your application successfully delivered the one-time passcode to the cardholder.", "Your application failed to deliver the one-time passcode to the cardholder." ] }, "success": { "additionalProperties": false, "description": "If your application was able to deliver the one-time passcode, this contains metadata about the delivery. Exactly one of `phone` or `email` must be provided.", "properties": { "email": { "description": "The email address that was used to verify the cardholder via one-time passcode.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "The phone number that was used to verify the cardholder via one-time passcode over SMS.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "result" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "digital_wallet_token": { "additionalProperties": false, "description": "If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.", "properties": { "approval": { "additionalProperties": false, "description": "If your application approves the provisioning attempt, this contains metadata about the digital wallet token that will be generated.", "properties": { "email": { "description": "An email address that can be used to verify the cardholder via one-time passcode.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "A phone number that can be used to verify the cardholder via one-time passcode over SMS.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "decline": { "additionalProperties": false, "description": "If your application declines the provisioning attempt, this contains details about the decline.", "properties": { "reason": { "description": "Why the tokenization attempt was declined. This is for logging purposes only and is not displayed to the end-user.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-event-categories": [] }, "action_an_inbound_mail_item_parameters": { "additionalProperties": false, "example": { "checks": [ { "account_id": "account_in71c4amph0vgo2qllky", "action": "deposit" }, { "action": "ignore" } ] }, "properties": { "checks": { "description": "The actions to perform on the Inbound Mail Item.", "items": { "additionalProperties": false, "example": { "account_id": "account_in71c4amph0vgo2qllky", "action": "deposit" }, "properties": { "account_id": { "description": "The identifier of the Account to deposit the check into.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "action": { "description": "The action to perform on the Inbound Mail Item.", "enum": [ "deposit", "ignore" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check will be deposited.", "The check will be ignored." ] } }, "required": [ "action" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "checks" ], "type": "object", "x-event-categories": [] }, "balance_lookup": { "additionalProperties": false, "description": "Represents a request to lookup the balance of an Account at a given point in time.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "available_balance": 100, "current_balance": 100, "loan": null, "type": "balance_lookup" }, "properties": { "account_id": { "description": "The identifier for the account for which the balance was queried.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "available_balance": { "description": "The Account's available balance, representing the current balance less any open Pending Transactions on the Account.", "type": "integer", "x-documentation-priority": "default" }, "current_balance": { "description": "The Account's current balance, representing the sum of all posted Transactions on the Account.", "type": "integer", "x-documentation-priority": "default" }, "loan": { "additionalProperties": false, "description": "The loan balances for the Account.", "properties": { "due_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan payment is due.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "due_balance": { "description": "The total amount due on the loan.", "type": "integer", "x-documentation-priority": "default" }, "past_due_balance": { "description": "The amount past due on the loan.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "due_balance", "past_due_balance", "due_at" ], "title": "Balance Lookup Loan", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Loans", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `balance_lookup`.", "enum": [ "balance_lookup" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "current_balance", "available_balance", "loan" ], "title": "Balance Lookup", "type": "object", "x-event-categories": [], "x-title-plural": "Balance Lookups" }, "card": { "additionalProperties": true, "description": "Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "authorization_controls": null, "billing_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "created_at": "2020-01-31T23:59:59Z", "description": "Office Expenses", "digital_wallet": { "digital_card_profile_id": "digital_card_profile_s3puplu90f04xhcwkiga", "email": "user@example.com", "phone": "+16505046304" }, "entity_id": null, "expiration_month": 11, "expiration_year": 2028, "id": "card_oubs0hwk5rn6knuecxg2", "idempotency_key": null, "last4": "4242", "status": "active", "type": "card" }, "properties": { "account_id": { "description": "The identifier for the account this card belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "authorization_controls": { "additionalProperties": false, "description": "Controls that restrict how this card can be used.", "properties": { "merchant_acceptor_identifier": { "additionalProperties": false, "description": "Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The Merchant Acceptor IDs that are allowed for authorizations on this card.", "items": { "additionalProperties": false, "properties": { "identifier": { "description": "The Merchant Acceptor ID.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "identifier" ], "title": "Card AuthorizationControls MerchantAcceptorIdentifier AllowedElement", "type": "object", "x-event-categories": [], "x-title-plural": "AllowedElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true }, "blocked": { "description": "The Merchant Acceptor IDs that are blocked for authorizations on this card.", "items": { "additionalProperties": false, "properties": { "identifier": { "description": "The Merchant Acceptor ID.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "identifier" ], "title": "Card AuthorizationControls MerchantAcceptorIdentifier BlockedElement", "type": "object", "x-event-categories": [], "x-title-plural": "BlockedElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true } }, "required": [ "allowed", "blocked" ], "title": "Card AuthorizationControls MerchantAcceptorIdentifier", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MerchantAcceptorIdentifiers", "nullable": true }, "merchant_category_code": { "additionalProperties": false, "description": "Restricts which Merchant Category Codes are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The Merchant Category Codes that are allowed for authorizations on this card.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code (MCC).", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "title": "Card AuthorizationControls MerchantCategoryCode AllowedElement", "type": "object", "x-event-categories": [], "x-title-plural": "AllowedElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true }, "blocked": { "description": "The Merchant Category Codes that are blocked for authorizations on this card.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code (MCC).", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "title": "Card AuthorizationControls MerchantCategoryCode BlockedElement", "type": "object", "x-event-categories": [], "x-title-plural": "BlockedElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true } }, "required": [ "allowed", "blocked" ], "title": "Card AuthorizationControls MerchantCategoryCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MerchantCategoryCodes", "nullable": true }, "merchant_country": { "additionalProperties": false, "description": "Restricts which merchant countries are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The merchant countries that are allowed for authorizations on this card.", "items": { "additionalProperties": false, "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "country" ], "title": "Card AuthorizationControls MerchantCountry AllowedElement", "type": "object", "x-event-categories": [], "x-title-plural": "AllowedElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true }, "blocked": { "description": "The merchant countries that are blocked for authorizations on this card.", "items": { "additionalProperties": false, "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "country" ], "title": "Card AuthorizationControls MerchantCountry BlockedElement", "type": "object", "x-event-categories": [], "x-title-plural": "BlockedElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true } }, "required": [ "allowed", "blocked" ], "title": "Card AuthorizationControls MerchantCountry", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MerchantCountries", "nullable": true }, "usage": { "additionalProperties": false, "description": "Controls how many times this card can be used.", "properties": { "category": { "description": "Whether the card is for a single use or multiple uses.", "enum": [ "single_use", "multi_use" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card can only be used for a single authorization.", "The card can be used for multiple authorizations." ] }, "multi_use": { "additionalProperties": false, "description": "Controls for multi-use cards. Required if and only if `category` is `multi_use`.", "properties": { "spending_limits": { "description": "Spending limits for this card. The most restrictive limit applies if multiple limits match.", "items": { "additionalProperties": false, "properties": { "interval": { "description": "The interval at which the spending limit is enforced.", "enum": [ "all_time", "per_transaction", "per_day", "per_week", "per_month" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The spending limit applies over the lifetime of the card.", "The spending limit applies per transaction.", "The spending limit applies per day. Resets nightly at midnight UTC.", "The spending limit applies per week. Resets weekly on Mondays at midnight UTC.", "The spending limit applies per month. Resets on the first of the month, midnight UTC." ] }, "merchant_category_codes": { "description": "The Merchant Category Codes (MCCs) this spending limit applies to. If not set, the limit applies to all transactions.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code (MCC).", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "title": "Card AuthorizationControls Usage MultiUse SpendingLimitsElement MerchantCategoryCodesElement", "type": "object", "x-event-categories": [], "x-title-plural": "MerchantCategoryCodesElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true }, "settlement_amount": { "description": "The maximum settlement amount permitted in the given interval.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "interval", "settlement_amount", "merchant_category_codes" ], "title": "Card AuthorizationControls Usage MultiUse SpendingLimitsElement", "type": "object", "x-event-categories": [], "x-title-plural": "SpendingLimitsElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true } }, "required": [ "spending_limits" ], "title": "Card AuthorizationControls Usage MultiUse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MultiUses", "nullable": true }, "single_use": { "additionalProperties": false, "description": "Controls for single-use cards. Required if and only if `category` is `single_use`.", "properties": { "settlement_amount": { "additionalProperties": false, "description": "The settlement amount constraint for this single-use card.", "properties": { "comparison": { "description": "The operator used to compare the settlement amount.", "enum": [ "equals", "less_than_or_equals" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The settlement amount must be exactly the specified value.", "The settlement amount must be less than or equal to the specified value." ] }, "value": { "description": "The settlement amount value.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "value", "comparison" ], "title": "Card AuthorizationControls Usage SingleUse SettlementAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "SettlementAmounts" } }, "required": [ "settlement_amount" ], "title": "Card AuthorizationControls Usage SingleUse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "SingleUses", "nullable": true } }, "required": [ "category", "single_use", "multi_use" ], "title": "Card AuthorizationControls Usage", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Usages", "nullable": true } }, "required": [ "usage", "merchant_category_code", "merchant_acceptor_identifier", "merchant_country" ], "title": "Card AuthorizationControls", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "AuthorizationControls", "nullable": true }, "billing_address": { "additionalProperties": false, "description": "The Card's billing address.", "example": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "properties": { "city": { "description": "The city of the billing address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line1": { "description": "The first line of the billing address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line2": { "description": "The second line of the billing address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The postal code of the billing address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The US state of the billing address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "postal_code" ], "title": "Card Billing Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Billing Addresses" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "The card's description for display purposes.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "digital_wallet": { "additionalProperties": false, "description": "The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.", "properties": { "digital_card_profile_id": { "description": "The digital card profile assigned to this digital card. Card profiles may also be assigned at the program level.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles", "nullable": true }, "email": { "description": "An email address that can be used to verify the cardholder via one-time passcode over email.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "phone": { "description": "A phone number that can be used to verify the cardholder via one-time passcode over SMS.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "email", "phone", "digital_card_profile_id" ], "title": "Card DigitalWallet", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "DigitalWallets", "nullable": true }, "entity_id": { "description": "The identifier for the entity associated with this card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities", "nullable": true }, "expiration_month": { "description": "The month the card expires in M format (e.g., August is 8).", "type": "integer", "x-documentation-priority": "default" }, "expiration_year": { "description": "The year the card expires in YYYY format (e.g., 2025).", "type": "integer", "x-documentation-priority": "default" }, "id": { "description": "The card identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "last4": { "description": "The last 4 digits of the Card's Primary Account Number.", "type": "string", "x-documentation-priority": "default" }, "status": { "description": "This indicates if payments can be made with the card.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card is active.", "The card is temporarily disabled.", "The card is permanently canceled." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card`.", "enum": [ "card" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "account_id", "entity_id", "created_at", "description", "last4", "expiration_month", "expiration_year", "status", "billing_address", "digital_wallet", "authorization_controls", "idempotency_key" ], "title": "Card", "type": "object", "x-event-categories": [ "card.created", "card.updated" ], "x-tag": "Cards", "x-title-plural": "Cards" }, "card_authentication": { "additionalProperties": true, "description": "Card Authentications are attempts to authenticate a transaction or a card with 3DS.", "example": { "access_control_server_transaction_identifier": "1a628378-4d43-4438-a31f-25c0e1bf2537", "billing_address_city": "New York", "billing_address_country": "US", "billing_address_line1": "33 Liberty Street", "billing_address_line2": null, "billing_address_line3": null, "billing_address_postal_code": "10045", "billing_address_state": "NY", "card_id": "card_oubs0hwk5rn6knuecxg2", "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cardholder_email": "user@example.com", "cardholder_name": "Ian Crease", "challenge": { "attempts": [ { "created_at": "2020-01-31T23:59:59Z", "outcome": "successful" } ], "created_at": "2020-01-31T23:59:59Z", "one_time_code": "123456", "real_time_decision_id": "real_time_decision_j76n2e810ezcg3zh5qtn", "verification_method": "text_message", "verification_value": "+16505046304" }, "created_at": "2020-01-31T23:59:59Z", "deny_reason": null, "device_channel": { "browser": { "accept_header": "text/html", "ip_address": "203.0.113.0", "javascript_enabled": "enabled", "language": "en-US", "user_agent": "Mozilla/5.0" }, "category": "browser", "merchant_initiated": null }, "directory_server_transaction_identifier": "8990a978-5eb2-4440-8539-5619e24b0b0d", "id": "card_authentication_xft30xjdubptlgrxboch", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_country": "US", "merchant_name": "AMAZON.COM", "message_category": { "category": "payment_authentication", "non_payment": null, "payment": { "purchase_amount": 861, "purchase_amount_cardholder_estimated": 1000, "purchase_currency": "EUR", "transaction_type": "goods_service_purchase" } }, "prior_authenticated_card_payment_id": null, "real_time_decision_id": null, "requestor_authentication_indicator": "payment_transaction", "requestor_challenge_indicator": "no_preference", "requestor_name": "Example Requestor", "requestor_url": "https://example.com", "shipping_address_city": "New York", "shipping_address_country": "US", "shipping_address_line1": "33 Liberty Street", "shipping_address_line2": null, "shipping_address_line3": null, "shipping_address_postal_code": "10045", "shipping_address_state": "NY", "status": "validating_challenge", "three_d_secure_server_transaction_identifier": "6839e1b0-dcae-482d-8166-40e44dd0d8cd", "type": "card_authentication" }, "properties": { "access_control_server_transaction_identifier": { "description": "A unique identifier assigned by the Access Control Server (us) for this transaction.", "type": "string", "x-documentation-priority": "default" }, "billing_address_city": { "description": "The city of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_country": { "description": "The country of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_line1": { "description": "The first line of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_line2": { "description": "The second line of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_line3": { "description": "The third line of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_postal_code": { "description": "The postal code of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_state": { "description": "The US state of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "card_id": { "description": "The identifier of the Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "cardholder_email": { "description": "The email address of the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "cardholder_name": { "description": "The name of the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "challenge": { "additionalProperties": false, "description": "Details about the challenge, if one was requested.", "properties": { "attempts": { "description": "Details about the challenge verification attempts, if any happened.", "items": { "additionalProperties": false, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card Authentication Challenge Attempt.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "outcome": { "description": "The outcome of the Card Authentication Challenge Attempt.", "enum": [ "successful", "failed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The attempt was successful.", "The attempt was unsuccessful." ] } }, "required": [ "created_at", "outcome" ], "title": "Card Authentication Challenge AttemptsElement", "type": "object", "x-event-categories": [], "x-title-plural": "AttemptsElements" }, "type": "array", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication Challenge was started.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "one_time_code": { "description": "The one-time code used for the Card Authentication Challenge.", "type": "string", "x-documentation-priority": "default" }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision used to deliver this challenge.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "verification_method": { "description": "The method used to verify the Card Authentication Challenge.", "enum": [ "text_message", "email", "none_available" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The one-time code was sent via text message.", "The one-time code was sent via email.", "The one-time code was not successfully delivered." ] }, "verification_value": { "description": "E.g., the email address or phone number used for the Card Authentication Challenge.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "one_time_code", "verification_method", "verification_value", "real_time_decision_id", "attempts" ], "title": "Card Authentication Challenge", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Challenges", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication was attempted.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "deny_reason": { "description": "The reason why this authentication attempt was denied, if it was.", "enum": [ "group_locked", "card_not_active", "entity_not_active", "transaction_not_allowed", "webhook_denied", "webhook_timed_out" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The group was locked.", "The card was not active.", "The entity was not active.", "The transaction was not allowed.", "The webhook was denied.", "The webhook timed out." ], "nullable": true }, "device_channel": { "additionalProperties": false, "description": "The device channel of the card authentication attempt.", "properties": { "browser": { "additionalProperties": false, "description": "Fields specific to the browser device channel.", "properties": { "accept_header": { "description": "The accept header from the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "ip_address": { "description": "The IP address of the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "javascript_enabled": { "description": "Whether JavaScript is enabled in the cardholder's browser.", "enum": [ "enabled", "disabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "JavaScript is enabled in the cardholder's browser.", "JavaScript is not enabled in the cardholder's browser." ], "nullable": true }, "language": { "description": "The language of the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "user_agent": { "description": "The user agent of the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "accept_header", "ip_address", "javascript_enabled", "language", "user_agent" ], "title": "Card Authentication DeviceChannel Browser", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Browsers", "nullable": true }, "category": { "description": "The category of the device channel.", "enum": [ "app", "browser", "three_ds_requestor_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt was made from an app.", "The authentication attempt was made from a browser.", "The authentication attempt was initiated by the 3DS Requestor." ] }, "merchant_initiated": { "additionalProperties": false, "description": "Fields specific to merchant initiated transactions.", "properties": { "indicator": { "description": "The merchant initiated indicator for the transaction.", "enum": [ "recurring_transaction", "installment_transaction", "add_card", "maintain_card_information", "account_verification", "split_delayed_shipment", "top_up", "mail_order", "telephone_order", "whitelist_status_check", "other_payment", "billing_agreement", "device_binding_status_check", "card_security_code_status_check", "delayed_shipment", "split_payment", "fido_credential_deletion", "fido_credential_registration", "decoupled_authentication_fallback" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Recurring transaction.", "Installment transaction.", "Add card.", "Maintain card information.", "Account verification.", "Split or delayed shipment.", "Top up.", "Mail order.", "Telephone order.", "Whitelist status check.", "Other payment.", "Billing agreement.", "Device binding status check.", "Card security code status check.", "Delayed shipment.", "Split payment.", "FIDO credential deletion.", "FIDO credential registration.", "Decoupled authentication fallback." ] } }, "required": [ "indicator" ], "title": "Card Authentication DeviceChannel MerchantInitiated", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MerchantInitiateds", "nullable": true } }, "required": [ "category", "merchant_initiated", "browser" ], "title": "Card Authentication DeviceChannel", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "directory_server_transaction_identifier": { "description": "A unique identifier assigned by the Directory Server (the card network) for this transaction.", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Card Authentication identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authentications" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_name": { "description": "The name of the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "message_category": { "additionalProperties": false, "description": "The message category of the card authentication attempt.", "properties": { "category": { "description": "The category of the card authentication attempt.", "enum": [ "payment_authentication", "non_payment_authentication" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt is for a payment.", "The authentication attempt is not for a payment." ] }, "non_payment": { "additionalProperties": false, "description": "Fields specific to non-payment authentication attempts.", "properties": {}, "title": "Card Authentication MessageCategory NonPayment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "NonPayments", "nullable": true }, "payment": { "additionalProperties": false, "description": "Fields specific to payment authentication attempts.", "properties": { "purchase_amount": { "description": "The purchase amount in minor units.", "type": "integer", "x-documentation-priority": "default" }, "purchase_amount_cardholder_estimated": { "description": "The purchase amount in the cardholder's currency (i.e., USD) estimated using daily conversion rates from the card network.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "purchase_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt's purchase currency.", "type": "string", "x-documentation-priority": "default" }, "transaction_type": { "description": "The type of transaction being authenticated.", "enum": [ "goods_service_purchase", "check_acceptance", "account_funding", "quasi_cash_transaction", "prepaid_activation_and_load" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Purchase of goods or services.", "Check acceptance.", "Account funding.", "Quasi-cash transaction.", "Prepaid activation and load." ], "nullable": true } }, "required": [ "purchase_amount", "purchase_currency", "purchase_amount_cardholder_estimated", "transaction_type" ], "title": "Card Authentication MessageCategory Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Payments", "nullable": true } }, "required": [ "category", "payment", "non_payment" ], "title": "Card Authentication MessageCategory", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "prior_authenticated_card_payment_id": { "description": "The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authentications", "nullable": true }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this authentication attempt.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "requestor_authentication_indicator": { "description": "The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction.", "enum": [ "payment_transaction", "recurring_transaction", "installment_transaction", "add_card", "maintain_card", "emv_token_cardholder_verification", "billing_agreement" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication is for a payment transaction.", "The authentication is for a recurring transaction.", "The authentication is for an installment transaction.", "The authentication is for adding a card.", "The authentication is for maintaining a card.", "The authentication is for EMV token cardholder verification.", "The authentication is for a billing agreement." ], "nullable": true }, "requestor_challenge_indicator": { "description": "Indicates whether a challenge is requested for this transaction.", "enum": [ "no_preference", "no_challenge_requested", "challenge_requested_3ds_requestor_preference", "challenge_requested_mandate", "no_challenge_requested_transactional_risk_analysis_already_performed", "no_challenge_requested_data_share_only", "no_challenge_requested_strong_consumer_authentication_already_performed", "no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required", "challenge_requested_whitelist_prompt_requested_if_challenge_required" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No preference.", "No challenge requested.", "Challenge requested, 3DS Requestor preference.", "Challenge requested, mandate.", "No challenge requested, transactional risk analysis already performed.", "No challenge requested, data share only.", "No challenge requested, strong consumer authentication already performed.", "No challenge requested, utilize whitelist exemption if no challenge required.", "Challenge requested, whitelist prompt requested if challenge required." ], "nullable": true }, "requestor_name": { "description": "The name of the 3DS requestor.", "type": "string", "x-documentation-priority": "default" }, "requestor_url": { "description": "The URL of the 3DS requestor.", "type": "string", "x-documentation-priority": "default" }, "shipping_address_city": { "description": "The city of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_country": { "description": "The country of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_line1": { "description": "The first line of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_line2": { "description": "The second line of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_line3": { "description": "The third line of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_postal_code": { "description": "The postal code of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_state": { "description": "The US state of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The status of the card authentication.", "enum": [ "denied", "authenticated_with_challenge", "authenticated_without_challenge", "awaiting_challenge", "validating_challenge", "canceled", "timed_out_awaiting_challenge", "errored", "exceeded_attempt_threshold" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt was denied.", "The authentication attempt was authenticated with a challenge.", "The authentication attempt was authenticated without a challenge.", "The authentication attempt is awaiting a challenge.", "The authentication attempt is validating a challenge.", "The authentication attempt was canceled.", "The authentication attempt timed out while awaiting a challenge.", "The authentication attempt errored.", "The authentication attempt exceeded the attempt threshold." ] }, "three_d_secure_server_transaction_identifier": { "description": "A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_authentication`.", "enum": [ "card_authentication" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "card_payment_id", "card_id", "prior_authenticated_card_payment_id", "message_category", "access_control_server_transaction_identifier", "three_d_secure_server_transaction_identifier", "directory_server_transaction_identifier", "device_channel", "cardholder_name", "cardholder_email", "requestor_authentication_indicator", "requestor_challenge_indicator", "requestor_name", "requestor_url", "merchant_category_code", "merchant_acceptor_id", "merchant_name", "merchant_country", "billing_address_line1", "billing_address_line2", "billing_address_line3", "billing_address_city", "billing_address_state", "billing_address_postal_code", "billing_address_country", "shipping_address_line1", "shipping_address_line2", "shipping_address_line3", "shipping_address_city", "shipping_address_state", "shipping_address_postal_code", "shipping_address_country", "status", "deny_reason", "real_time_decision_id", "challenge" ], "title": "Card Authentication", "type": "object", "x-event-categories": [], "x-title-plural": "Card Authentications" }, "card_authorization": { "additionalProperties": true, "description": "Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.", "example": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "properties": { "actioner": { "description": "Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.", "enum": [ "user", "increase", "network" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This object was actioned by the user through a real-time decision.", "This object was actioned by Increase without user intervention.", "This object was actioned by the network, through stand-in processing." ] }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Authorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Card Authorization AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "amount": { "description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "direction": { "description": "The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.", "enum": [ "settlement", "refund" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regular card authorization where funds are debited from the cardholder.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder." ] }, "expires_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization will expire and the pending transaction will be released.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Card Authorization identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Card Authorization NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Card Authorization NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Card Authorization NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Authorization NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction associated with this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "presentment_amount": { "description": "The pending amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "processing_category": { "description": "The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.", "enum": [ "account_funding", "automatic_fuel_dispenser", "bill_payment", "original_credit", "purchase", "quasi_cash", "refund", "cash_disbursement", "balance_inquiry", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.", "Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.", "A transaction used to pay a bill.", "Original credit transactions are used to send money to a cardholder.", "A regular purchase.", "Quasi-cash transactions represent purchases of items which may be convertible to cash.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.", "Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.", "A balance inquiry transaction is used to check the balance of an account associated with a card.", "The processing category is unknown." ] }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card authorization.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Authorization Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_authorization`.", "enum": [ "card_authorization" ], "type": "string", "x-documentation-priority": "default" }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Card Authorization Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Card Authorization Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Card Authorization Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Card Authorization Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "type", "id", "card_payment_id", "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "amount", "presentment_amount", "presentment_currency", "currency", "direction", "actioner", "processing_category", "expires_at", "real_time_decision_id", "pending_transaction_id", "scheme_fees" ], "title": "Card Authorization", "type": "object", "x-event-categories": [], "x-title-plural": "Card Authorizations" }, "card_authorization_expiration": { "additionalProperties": true, "description": "Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer.", "example": { "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "expired_amount": 20, "id": "card_authorization_expiration_9xxbjtmixs8sfluzux2e", "network": "visa", "type": "card_authorization_expiration" }, "properties": { "card_authorization_id": { "description": "The identifier for the Card Authorization this reverses.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "expired_amount": { "description": "The amount of this authorization expiration in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "id": { "description": "The Card Authorization Expiration identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorization Expirations" }, "network": { "description": "The card network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_authorization_expiration`.", "enum": [ "card_authorization_expiration" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "expired_amount", "currency", "card_authorization_id", "network" ], "title": "Card Authorization Expiration", "type": "object", "x-event-categories": [], "x-title-plural": "Card Authorization Expirations" }, "card_balance_inquiry": { "additionalProperties": true, "description": "Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM.", "example": { "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "balance": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "id": "card_balance_inquiry_pt06vq4e7qzvv01je0yt", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "physical_card_id": null, "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_balance_inquiry", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "properties": { "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Balance Inquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Card Balance Inquiry AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "balance": { "description": "The balance amount in the minor unit of the account's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "id": { "description": "The Card Balance Inquiry identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Balance Inquiries" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Card Balance Inquiry NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Card Balance Inquiry NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Card Balance Inquiry NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Balance Inquiry NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card balance inquiry.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Balance Inquiry Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_balance_inquiry`.", "enum": [ "card_balance_inquiry" ], "type": "string", "x-documentation-priority": "default" }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Card Balance Inquiry Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Card Balance Inquiry Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Card Balance Inquiry Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Card Balance Inquiry Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "type", "id", "card_payment_id", "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "balance", "currency", "real_time_decision_id", "scheme_fees" ], "title": "Card Balance Inquiry", "type": "object", "x-event-categories": [], "x-title-plural": "Card Balance Inquiries" }, "card_details": { "additionalProperties": false, "description": "An object containing the sensitive details (card number, CVC, PIN, etc) for a Card. These details are not included in the Card object. If you'd prefer to never access these details directly, you can use the [embedded iframe](/documentation/embedded-card-component) to display the information to your users.", "example": { "card_id": "card_oubs0hwk5rn6knuecxg2", "expiration_month": 7, "expiration_year": 2025, "pin": "1234", "primary_account_number": "4242424242424242", "type": "card_details", "verification_code": "123" }, "properties": { "card_id": { "description": "The identifier for the Card for which sensitive details have been returned.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "expiration_month": { "description": "The month the card expires in M format (e.g., August is 8).", "type": "integer", "x-documentation-priority": "default" }, "expiration_year": { "description": "The year the card expires in YYYY format (e.g., 2025).", "type": "integer", "x-documentation-priority": "default" }, "pin": { "description": "The 4-digit PIN for the card, for use with ATMs.", "type": "string", "x-documentation-priority": "default" }, "primary_account_number": { "description": "The card number.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_details`.", "enum": [ "card_details" ], "type": "string", "x-documentation-priority": "default" }, "verification_code": { "description": "The three-digit verification code for the card. It's also known as the Card Verification Code (CVC), the Card Verification Value (CVV), or the Card Identification (CID).", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "card_id", "primary_account_number", "expiration_month", "expiration_year", "verification_code", "pin" ], "title": "Card Details", "type": "object", "x-event-categories": [], "x-title-plural": "Card Details" }, "card_dispute": { "additionalProperties": false, "description": "If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.", "example": { "amount": 1000, "card_id": "card_oubs0hwk5rn6knuecxg2", "created_at": "2020-01-31T23:59:59Z", "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "id": "card_dispute_h9sc95nbl1cgltpp7men", "idempotency_key": null, "loss": null, "network": "visa", "status": "pending_response", "type": "card_dispute", "user_submission_required_by": null, "visa": { "network_events": [], "required_user_submission_category": null, "user_submissions": [ { "accepted_at": null, "amount": 1000, "attachment_files": [], "category": "chargeback", "chargeback": { "authorization": null, "category": "fraud", "consumer_canceled_merchandise": null, "consumer_canceled_recurring_transaction": null, "consumer_canceled_services": null, "consumer_counterfeit_merchandise": null, "consumer_credit_not_processed": null, "consumer_damaged_or_defective_merchandise": null, "consumer_merchandise_misrepresentation": null, "consumer_merchandise_not_as_described": null, "consumer_merchandise_not_received": null, "consumer_non_receipt_of_cash": null, "consumer_original_credit_transaction_not_accepted": null, "consumer_quality_merchandise": null, "consumer_quality_services": null, "consumer_services_misrepresentation": null, "consumer_services_not_as_described": null, "consumer_services_not_received": null, "fraud": { "fraud_type": "lost" }, "processing_error": null }, "created_at": "2020-01-31T23:59:59Z", "explanation": null, "further_information_requested_at": null, "further_information_requested_reason": null, "status": "pending_reviewing", "updated_at": "2020-01-31T23:59:59Z" } ] }, "win": null, "withdrawal": null }, "properties": { "amount": { "description": "The amount of the dispute.", "type": "integer", "x-documentation-priority": "default" }, "card_id": { "description": "The Card that the Card Dispute is associated with.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "disputed_transaction_id": { "description": "The identifier of the Transaction that was disputed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "id": { "description": "The Card Dispute identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Disputes" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "loss": { "additionalProperties": false, "description": "If the Card Dispute's status is `lost`, this will contain details of the lost dispute.", "example": { "lost_at": "2020-01-31T23:59:59Z", "reason": "user_withdrawn" }, "properties": { "lost_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was lost.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "The reason the Card Dispute was lost.", "enum": [ "user_withdrawn", "loss" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The user withdrew the Card Dispute.", "The Card Dispute was lost according to network rules." ] } }, "required": [ "lost_at", "reason" ], "title": "Card Dispute Card Dispute Loss", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Losses", "nullable": true }, "network": { "description": "The network that the Card Dispute is associated with.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa: details will be under the `visa` object.", "Pulse: details will be under the `pulse` object." ] }, "status": { "description": "The status of the Card Dispute.", "enum": [ "user_submission_required", "pending_user_submission_reviewing", "pending_user_submission_submitting", "pending_user_withdrawal_submitting", "pending_response", "lost", "won" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A User Submission is required to continue with the Card Dispute.", "The most recent User Submission is being reviewed.", "The most recent User Submission is being submitted to the network.", "The user's withdrawal of the Card Dispute is being submitted to the network.", "The Card Dispute is pending a response from the network.", "The Card Dispute has been lost and funds previously credited from the acceptance have been debited.", "The Card Dispute has been won and no further action can be taken." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_dispute`.", "enum": [ "card_dispute" ], "type": "string", "x-documentation-priority": "default" }, "user_submission_required_by": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the user submission is required by. Present only if status is `user_submission_required` and a user submission is required by a certain time. Otherwise, this will be `nil`.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "visa": { "description": "Card Dispute information for card payments processed over Visa's network. This field will be present in the JSON response if and only if `network` is equal to `visa`.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_dispute_visa" } ], "nullable": true }, "win": { "additionalProperties": false, "description": "If the Card Dispute's status is `won`, this will contain details of the won dispute.", "example": { "won_at": "2020-01-31T23:59:59Z" }, "properties": { "won_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was won.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "won_at" ], "title": "Card Dispute Card Dispute Win", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Wins", "nullable": true }, "withdrawal": { "additionalProperties": false, "description": "If the Card Dispute has been withdrawn, this will contain details of the withdrawal.", "example": { "explanation": "The cardholder requested a withdrawal of the dispute." }, "properties": { "explanation": { "description": "The explanation for the withdrawal of the Card Dispute.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Card Dispute Card Dispute Withdrawal", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Withdrawals", "nullable": true } }, "required": [ "type", "id", "amount", "user_submission_required_by", "status", "created_at", "disputed_transaction_id", "network", "loss", "win", "withdrawal", "card_id", "visa", "idempotency_key" ], "title": "Card Dispute", "type": "object", "x-event-categories": [ "card_dispute.created", "card_dispute.updated" ], "x-tag": "Card Disputes", "x-title-plural": "Card Disputes" }, "card_dispute_file_attachment": { "additionalProperties": false, "properties": { "file_id": { "description": "The ID of the file attached to the Card Dispute.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id" ], "title": "Card Dispute File Attachment", "type": "object", "x-event-categories": [], "x-title-plural": "Card Dispute File Attachments" }, "card_dispute_financial_visa": { "additionalProperties": false, "example": { "event_type": "chargeback_submitted" }, "properties": { "event_type": { "description": "The type of card dispute financial event.", "enum": [ "chargeback_submitted", "merchant_prearbitration_decline_submitted", "merchant_prearbitration_received", "represented", "user_prearbitration_decline_received", "user_prearbitration_submitted", "user_withdrawal_submitted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The user's chargeback was submitted.", "The user declined the merchant's pre-arbitration submission.", "The merchant's pre-arbitration submission was received.", "The transaction was re-presented by the merchant.", "The user's pre-arbitration was declined by the merchant.", "The user's pre-arbitration was submitted.", "The user withdrew from the dispute." ] } }, "required": [ "event_type" ], "title": "Card Dispute Financial Visa-specific details", "type": "object", "x-event-categories": [], "x-title-plural": "Card Dispute Financial Visa-specific details" }, "card_dispute_list": { "additionalProperties": true, "description": "A list of Card Dispute objects.", "example": { "data": [ { "amount": 1000, "card_id": "card_oubs0hwk5rn6knuecxg2", "created_at": "2020-01-31T23:59:59Z", "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "id": "card_dispute_h9sc95nbl1cgltpp7men", "idempotency_key": null, "loss": null, "network": "visa", "status": "pending_response", "type": "card_dispute", "user_submission_required_by": null, "visa": { "network_events": [], "required_user_submission_category": null, "user_submissions": [ { "accepted_at": null, "amount": 1000, "attachment_files": [], "category": "chargeback", "chargeback": { "authorization": null, "category": "fraud", "consumer_canceled_merchandise": null, "consumer_canceled_recurring_transaction": null, "consumer_canceled_services": null, "consumer_counterfeit_merchandise": null, "consumer_credit_not_processed": null, "consumer_damaged_or_defective_merchandise": null, "consumer_merchandise_misrepresentation": null, "consumer_merchandise_not_as_described": null, "consumer_merchandise_not_received": null, "consumer_non_receipt_of_cash": null, "consumer_original_credit_transaction_not_accepted": null, "consumer_quality_merchandise": null, "consumer_quality_services": null, "consumer_services_misrepresentation": null, "consumer_services_not_as_described": null, "consumer_services_not_received": null, "fraud": { "fraud_type": "lost" }, "processing_error": null }, "created_at": "2020-01-31T23:59:59Z", "explanation": null, "further_information_requested_at": null, "further_information_requested_reason": null, "status": "pending_reviewing", "updated_at": "2020-01-31T23:59:59Z" } ] }, "win": null, "withdrawal": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card_dispute" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card Dispute List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Dispute Lists" }, "card_dispute_visa": { "additionalProperties": false, "properties": { "network_events": { "description": "The network events for the Card Dispute.", "items": { "$ref": "#/components/schemas/card_dispute_visa_network_event" }, "type": "array", "x-documentation-priority": "default" }, "required_user_submission_category": { "description": "The category of the currently required user submission if the user wishes to proceed with the dispute. Present if and only if status is `user_submission_required`. Otherwise, this will be `nil`.", "enum": [ "chargeback", "merchant_prearbitration_decline", "user_prearbitration" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A Chargeback User Submission is required.", "A Merchant Pre Arbitration Decline User Submission is required.", "A User Initiated Pre Arbitration User Submission is required." ], "nullable": true }, "user_submissions": { "description": "The user submissions for the Card Dispute.", "items": { "$ref": "#/components/schemas/card_dispute_visa_user_submission" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "network_events", "required_user_submission_category", "user_submissions" ], "title": "Card Dispute Visa-specific details", "type": "object", "x-event-categories": [ "card_dispute.created", "card_dispute.updated" ], "x-title-plural": "Card Dispute Visa-specific details" }, "card_dispute_visa_network_event": { "additionalProperties": false, "properties": { "attachment_files": { "description": "The files attached to the Visa Card Dispute User Submission.", "items": { "$ref": "#/components/schemas/card_dispute_file_attachment" }, "type": "array", "x-documentation-priority": "default" }, "category": { "description": "The category of the user submission. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "chargeback_accepted", "chargeback_submitted", "chargeback_timed_out", "merchant_prearbitration_decline_submitted", "merchant_prearbitration_received", "merchant_prearbitration_timed_out", "represented", "representment_timed_out", "user_prearbitration_accepted", "user_prearbitration_declined", "user_prearbitration_submitted", "user_prearbitration_timed_out", "user_withdrawal_submitted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Card Dispute Chargeback Accepted Visa Network Event: details will be under the `chargeback_accepted` object.", "Card Dispute Chargeback Submitted Visa Network Event: details will be under the `chargeback_submitted` object.", "Card Dispute Chargeback Timed Out Visa Network Event: details will be under the `chargeback_timed_out` object.", "Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event: details will be under the `merchant_prearbitration_decline_submitted` object.", "Card Dispute Merchant Pre-Arbitration Received Visa Network Event: details will be under the `merchant_prearbitration_received` object.", "Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event: details will be under the `merchant_prearbitration_timed_out` object.", "Card Dispute Re-presented Visa Network Event: details will be under the `represented` object.", "Card Dispute Re-presentment Timed Out Visa Network Event: details will be under the `representment_timed_out` object.", "Card Dispute User Pre-Arbitration Accepted Visa Network Event: details will be under the `user_prearbitration_accepted` object.", "Card Dispute User Pre-Arbitration Declined Visa Network Event: details will be under the `user_prearbitration_declined` object.", "Card Dispute User Pre-Arbitration Submitted Visa Network Event: details will be under the `user_prearbitration_submitted` object.", "Card Dispute User Pre-Arbitration Timed Out Visa Network Event: details will be under the `user_prearbitration_timed_out` object.", "Card Dispute User Withdrawal Submitted Visa Network Event: details will be under the `user_withdrawal_submitted` object." ] }, "chargeback_accepted": { "additionalProperties": false, "description": "A Card Dispute Chargeback Accepted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_accepted`. Contains the details specific to a chargeback accepted Visa Card Dispute Network Event, which represents that a chargeback has been accepted by the merchant.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Chargeback Accepted Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Chargeback Accepted Visa Network Events", "nullable": true }, "chargeback_submitted": { "additionalProperties": false, "description": "A Card Dispute Chargeback Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_submitted`. Contains the details specific to a chargeback submitted Visa Card Dispute Network Event, which represents that a chargeback has been submitted to the network.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Chargeback Submitted Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Chargeback Submitted Visa Network Events", "nullable": true }, "chargeback_timed_out": { "additionalProperties": false, "description": "A Card Dispute Chargeback Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_timed_out`. Contains the details specific to a chargeback timed out Visa Card Dispute Network Event, which represents that the chargeback has timed out in the user's favor.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Chargeback Timed Out Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Chargeback Timed Out Visa Network Events", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute Network Event was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "dispute_financial_transaction_id": { "description": "The dispute financial transaction that resulted from the network event, if any.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "merchant_prearbitration_decline_submitted": { "additionalProperties": false, "description": "A Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_decline_submitted`. Contains the details specific to a merchant prearbitration decline submitted Visa Card Dispute Network Event, which represents that the user has declined the merchant's request for a prearbitration request decision in their favor.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Events", "nullable": true }, "merchant_prearbitration_received": { "additionalProperties": false, "description": "A Card Dispute Merchant Pre-Arbitration Received Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_received`. Contains the details specific to a merchant prearbitration received Visa Card Dispute Network Event, which represents that the merchant has issued a prearbitration request in the user's favor.", "example": { "cardholder_no_longer_disputes": { "explanation": "See the attached email where the cardholder confirmed that they no longer dispute the transaction." }, "compelling_evidence": null, "credit_or_reversal_processed": null, "delayed_charge_transaction": null, "evidence_of_imprint": null, "invalid_dispute": null, "non_fiat_currency_or_non_fungible_token_received": null, "prior_undisputed_non_fraud_transactions": null, "reason": "cardholder_no_longer_disputes" }, "properties": { "cardholder_no_longer_disputes": { "additionalProperties": false, "description": "Cardholder no longer disputes details. Present if and only if `reason` is `cardholder_no_longer_disputes`.", "example": { "explanation": "See the attached email where the cardholder confirmed that they no longer dispute the transaction." }, "properties": { "explanation": { "description": "Explanation for why the merchant believes the cardholder no longer disputes the transaction.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Cardholder No Longer Disputes", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder No Longer Disputes", "nullable": true }, "compelling_evidence": { "additionalProperties": false, "description": "Compelling evidence details. Present if and only if `reason` is `compelling_evidence`.", "example": { "category": "merchandise_use", "explanation": null }, "properties": { "category": { "description": "The category of compelling evidence provided by the merchant.", "enum": [ "authorized_signer", "delivery", "delivery_at_place_of_employment", "digital_goods_download", "dynamic_currency_conversion_actively_chosen", "flight_manifest_and_purchase_itinerary", "household_member_signer", "legitimate_spend_across_payment_types_for_same_merchandise", "merchandise_use", "passenger_transport_ticket_use", "recurring_transaction_with_binding_contract_or_previous_undisputed_transaction", "signed_delivery_or_pickup_form", "signed_mail_order_phone_order_form", "travel_and_expense_loyalty_transaction", "travel_and_expense_subsequent_purchase" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Authorized signer known by the cardholder.", "Proof of delivery.", "Proof of delivery to cardholder at place of employment.", "Proof of digital goods download.", "Dynamic Currency Conversion actively chosen by cardholder.", "Flight manifest with corresponding purchase itinerary record.", "Signer is member of cardholder's household.", "Legitimate spend across multiple payment types for same merchandise.", "Documentation to prove the cardholder is in possession of and/or using the merchandise.", "Passenger transport: proof ticket was received, scanned at gate or other transaction related to original (for example, frequent flyer miles.)", "Recurring transaction with binding contract or previous undisputed recurring transactions and proof the cardholder is using the merchandise or service.", "Signed delivery form, or copy of/details of identification from cardholder as proof goods were picked up at merchant location.", "Signed Mail Order/Phone Order form.", "Travel & Expense: loyalty transactions related to purchase.", "Travel & Expense: subsequent purchases made throughout service period." ] }, "explanation": { "description": "Explanation of the compelling evidence provided by the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "category", "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Compelling Evidence", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Compelling Evidences", "nullable": true }, "credit_or_reversal_processed": { "additionalProperties": false, "description": "Credit or reversal processed details. Present if and only if `reason` is `credit_or_reversal_processed`.", "example": { "amount": 4900, "currency": "USD", "explanation": "The user did not provide the required documentation.", "processed_at": "2020-01-31" }, "properties": { "amount": { "description": "The amount of the credit or reversal in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the credit or reversal's currency.", "type": "string", "x-documentation-priority": "default" }, "explanation": { "description": "Explanation for why the merchant believes the credit or reversal was processed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "processed_at": { "description": "The date the credit or reversal was processed.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "processed_at", "amount", "currency" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Credit Or Reversal Processed", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Credit Or Reversal Processeds", "nullable": true }, "delayed_charge_transaction": { "additionalProperties": false, "description": "Delayed charge transaction details. Present if and only if `reason` is `delayed_charge_transaction`.", "example": { "explanation": null }, "properties": { "explanation": { "description": "Additional details about the delayed charge transaction.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Delayed Charge Transaction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Delayed Charge Transactions", "nullable": true }, "evidence_of_imprint": { "additionalProperties": false, "description": "Evidence of imprint details. Present if and only if `reason` is `evidence_of_imprint`.", "example": { "explanation": null }, "properties": { "explanation": { "description": "Explanation of the evidence of imprint.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Evidence Of Imprint", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Evidence Of Imprints", "nullable": true }, "invalid_dispute": { "additionalProperties": false, "description": "Invalid dispute details. Present if and only if `reason` is `invalid_dispute`.", "example": { "explanation": "The user did not provide the required documentation.", "reason": "other" }, "properties": { "explanation": { "description": "Explanation for why the dispute is considered invalid by the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reason": { "description": "The reason a merchant considers the dispute invalid.", "enum": [ "other", "special_authorization_procedures_followed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Other.", "Special authorization procedures followed." ] } }, "required": [ "reason", "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Invalid Dispute", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Invalid Disputes", "nullable": true }, "non_fiat_currency_or_non_fungible_token_received": { "additionalProperties": false, "description": "Non-fiat currency or non-fungible token received details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_received`.", "example": { "blockchain_transaction_hash": "0x1234567890123456789012345678901234567890", "destination_wallet_address": "0x1234567890123456789012345678901234567890", "prior_approved_transactions": "0x1234567890123456789012345678901234567890" }, "properties": { "blockchain_transaction_hash": { "description": "Blockchain transaction hash.", "type": "string", "x-documentation-priority": "default" }, "destination_wallet_address": { "description": "Destination wallet address.", "type": "string", "x-documentation-priority": "default" }, "prior_approved_transactions": { "description": "Prior approved transactions.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "destination_wallet_address", "blockchain_transaction_hash", "prior_approved_transactions" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Non Fiat Currency Or Non Fungible Token Received", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Non Fiat Currency Or Non Fungible Token Receiveds", "nullable": true }, "prior_undisputed_non_fraud_transactions": { "additionalProperties": false, "description": "Prior undisputed non-fraud transactions details. Present if and only if `reason` is `prior_undisputed_non_fraud_transactions`.", "example": { "explanation": null }, "properties": { "explanation": { "description": "Explanation of the prior undisputed non-fraud transactions provided by the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Prior Undisputed Non Fraud Transactions", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Prior Undisputed Non Fraud Transactions", "nullable": true }, "reason": { "description": "The reason the merchant re-presented the dispute.", "enum": [ "cardholder_no_longer_disputes", "compelling_evidence", "credit_or_reversal_processed", "delayed_charge_transaction", "evidence_of_imprint", "invalid_dispute", "non_fiat_currency_or_non_fungible_token_received", "prior_undisputed_non_fraud_transactions" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder no longer disputes the transaction.", "Compelling evidence.", "Credit or reversal was processed.", "Delayed charge transaction.", "Evidence of imprint.", "Invalid dispute.", "Non-fiat currency or non-fungible token was received by the cardholder.", "Prior undisputed non-fraud transactions." ] } }, "required": [ "reason", "cardholder_no_longer_disputes", "compelling_evidence", "credit_or_reversal_processed", "delayed_charge_transaction", "evidence_of_imprint", "invalid_dispute", "non_fiat_currency_or_non_fungible_token_received", "prior_undisputed_non_fraud_transactions" ], "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Merchant Pre-Arbitration Received Visa Network Events", "nullable": true }, "merchant_prearbitration_timed_out": { "additionalProperties": false, "description": "A Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_timed_out`. Contains the details specific to a merchant prearbitration timed out Visa Card Dispute Network Event, which represents that the user has timed out responding to the merchant's prearbitration request.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Events", "nullable": true }, "represented": { "additionalProperties": false, "description": "A Card Dispute Re-presented Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `represented`. Contains the details specific to a re-presented Visa Card Dispute Network Event, which represents that the merchant has declined the user's chargeback and has re-presented the payment.", "example": { "cardholder_no_longer_disputes": null, "credit_or_reversal_processed": null, "invalid_dispute": { "explanation": "The user did not provide the required documentation.", "reason": "other" }, "non_fiat_currency_or_non_fungible_token_as_described": null, "non_fiat_currency_or_non_fungible_token_received": null, "proof_of_cash_disbursement": null, "reason": "invalid_dispute", "reversal_issued": null }, "properties": { "cardholder_no_longer_disputes": { "additionalProperties": false, "description": "Cardholder no longer disputes details. Present if and only if `reason` is `cardholder_no_longer_disputes`.", "example": { "explanation": "See the attached email where the cardholder confirmed that they no longer dispute the transaction." }, "properties": { "explanation": { "description": "Explanation for why the merchant believes the cardholder no longer disputes the transaction.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Cardholder No Longer Disputes", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder No Longer Disputes", "nullable": true }, "credit_or_reversal_processed": { "additionalProperties": false, "description": "Credit or reversal processed details. Present if and only if `reason` is `credit_or_reversal_processed`.", "example": { "amount": 4900, "currency": "USD", "explanation": "The user did not provide the required documentation.", "processed_at": "2020-01-31" }, "properties": { "amount": { "description": "The amount of the credit or reversal in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the credit or reversal's currency.", "type": "string", "x-documentation-priority": "default" }, "explanation": { "description": "Explanation for why the merchant believes the credit or reversal was processed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "processed_at": { "description": "The date the credit or reversal was processed.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "processed_at", "amount", "currency" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Credit Or Reversal Processed", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Credit Or Reversal Processeds", "nullable": true }, "invalid_dispute": { "additionalProperties": false, "description": "Invalid dispute details. Present if and only if `reason` is `invalid_dispute`.", "example": { "explanation": "The user did not provide the required documentation.", "reason": "other" }, "properties": { "explanation": { "description": "Explanation for why the dispute is considered invalid by the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reason": { "description": "The reason a merchant considers the dispute invalid.", "enum": [ "automatic_teller_machine_transaction_proof_provided", "balance_of_partial_prepayment_not_paid", "cardholder_canceled_before_expected_merchandise_receipt_date", "cardholder_canceled_before_expected_services_receipt_date", "cardholder_canceled_different_date", "cardholder_did_not_cancel_according_to_policy", "cardholder_received_merchandise", "country_code_correct", "credit_processed_correctly", "currency_correct", "dispute_is_for_quality", "dispute_is_for_visa_cash_back_transaction_portion", "disputed_amount_is_value_added_tax", "disputed_amount_is_value_added_tax_no_credit_receipt_provided", "limited_return_or_cancellation_policy_properly_disclosed", "merchandise_held_at_cardholder_customs_agency", "merchandise_matches_description", "merchandise_not_counterfeit", "merchandise_not_damaged", "merchandise_not_defective", "merchandise_provided_prior_to_cancellation_date", "merchandise_quality_matches_description", "merchandise_return_not_attempted", "merchant_not_notified_of_closed_account", "name_on_flight_manifest_matches_purchase", "no_credit_receipt_provided", "other", "processing_error_incorrect", "returned_mechandise_held_at_customs_agency_outside_merchant_country", "services_match_description", "services_provided_prior_to_cancellation_date", "services_used_after_cancellation_date", "terms_of_service_not_misrepresented", "transaction_code_correct" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Automatic Teller Machine (ATM) transaction proof provided.", "Balance of partial prepayment not paid.", "Cardholder canceled before expected receipt date of the merchandise.", "Cardholder canceled before expected receipt date of the services.", "Cardholder canceled on a different date than claimed.", "Cardholder received did not cancel according to policy.", "Cardholder received the merchandise.", "Country code is correct.", "Credit was processed correctly.", "Currency is correct.", "Dispute is for quality.", "Dispute is for Visa Cash Back transaction portion.", "Disputed amount is Value Added Tax (VAT).", "Disputed amount is Value Added Tax (VAT) but no credit receipt was provided by the cardholder.", "Limited return or cancellation policy was properly disclosed.", "Merchandise held at cardholder customs agency.", "Merchandise matches the merchant's description.", "Merchandise is not counterfeit.", "Merchandise is not damaged.", "Merchandise is not defective.", "Merchandise was provided prior to the cancellation date.", "Merchandise quality matches the merchant's description.", "Merchandise was not attempted returned to the merchant.", "Merchant was not notified of the closed account.", "Name on manifest of departed flight matches name on purchased itinerary.", "No credit receipt was provided by the cardholder.", "Other.", "The claimed processing error did not occur.", "Returned merchandise held at customs agency outside the merchant's country.", "Services match the merchant's description.", "Services were provided prior to the cancellation date.", "Services were used after the cancellation date and prior to the dispute submission date.", "Terms of service were not misrepresented.", "Transaction code is correct." ] } }, "required": [ "reason", "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Invalid Dispute", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Invalid Disputes", "nullable": true }, "non_fiat_currency_or_non_fungible_token_as_described": { "additionalProperties": false, "description": "Non-fiat currency or non-fungible token as described details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_as_described`.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Non Fiat Currency Or Non Fungible Token As Described", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Non Fiat Currency Or Non Fungible Token As Describeds", "nullable": true }, "non_fiat_currency_or_non_fungible_token_received": { "additionalProperties": false, "description": "Non-fiat currency or non-fungible token received details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_received`.", "example": { "blockchain_transaction_hash": "0x1234567890123456789012345678901234567890", "destination_wallet_address": "0x1234567890123456789012345678901234567890", "prior_approved_transactions": "0x1234567890123456789012345678901234567890" }, "properties": { "blockchain_transaction_hash": { "description": "Blockchain transaction hash.", "type": "string", "x-documentation-priority": "default" }, "destination_wallet_address": { "description": "Destination wallet address.", "type": "string", "x-documentation-priority": "default" }, "prior_approved_transactions": { "description": "Prior approved transactions.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "destination_wallet_address", "blockchain_transaction_hash", "prior_approved_transactions" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Non Fiat Currency Or Non Fungible Token Received", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Non Fiat Currency Or Non Fungible Token Receiveds", "nullable": true }, "proof_of_cash_disbursement": { "additionalProperties": false, "description": "Proof of cash disbursement details. Present if and only if `reason` is `proof_of_cash_disbursement`.", "example": { "explanation": null }, "properties": { "explanation": { "description": "Explanation for why the merchant believes the evidence provides proof of cash disbursement.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Proof Of Cash Disbursement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Proof Of Cash Disbursements", "nullable": true }, "reason": { "description": "The reason the merchant re-presented the dispute.", "enum": [ "cardholder_no_longer_disputes", "credit_or_reversal_processed", "invalid_dispute", "non_fiat_currency_or_non_fungible_token_as_described", "non_fiat_currency_or_non_fungible_token_received", "proof_of_cash_disbursement", "reversal_issued" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder no longer disputes the transaction.", "Credit or reversal was processed.", "Invalid dispute.", "Non-fiat currency or non-fungible token is as described by the merchant.", "Non-fiat currency or non-fungible token was received by the cardholder.", "Proof of cash disbursement provided.", "Reversal issued by merchant." ] }, "reversal_issued": { "additionalProperties": false, "description": "Reversal issued by merchant details. Present if and only if `reason` is `reversal_issued`.", "example": { "explanation": "The merchant has issued a reversal for the transaction prior to the dispute being filed." }, "properties": { "explanation": { "description": "Explanation of the reversal issued by the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "explanation" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Reversal Issued By Merchant", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Reversal Issued By Merchants", "nullable": true } }, "required": [ "reason", "cardholder_no_longer_disputes", "credit_or_reversal_processed", "invalid_dispute", "non_fiat_currency_or_non_fungible_token_as_described", "non_fiat_currency_or_non_fungible_token_received", "proof_of_cash_disbursement", "reversal_issued" ], "title": "Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Re-presented Visa Network Events", "nullable": true }, "representment_timed_out": { "additionalProperties": false, "description": "A Card Dispute Re-presentment Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `representment_timed_out`. Contains the details specific to a re-presentment time-out Visa Card Dispute Network Event, which represents that the user did not respond to the re-presentment by the merchant within the time limit.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute Re-presentment Timed Out Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Re-presentment Timed Out Visa Network Events", "nullable": true }, "user_prearbitration_accepted": { "additionalProperties": false, "description": "A Card Dispute User Pre-Arbitration Accepted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_accepted`. Contains the details specific to a user prearbitration accepted Visa Card Dispute Network Event, which represents that the merchant has accepted the user's prearbitration request in the user's favor.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Accepted Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute User Pre-Arbitration Accepted Visa Network Events", "nullable": true }, "user_prearbitration_declined": { "additionalProperties": false, "description": "A Card Dispute User Pre-Arbitration Declined Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_declined`. Contains the details specific to a user prearbitration declined Visa Card Dispute Network Event, which represents that the merchant has declined the user's prearbitration request.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Declined Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute User Pre-Arbitration Declined Visa Network Events", "nullable": true }, "user_prearbitration_submitted": { "additionalProperties": false, "description": "A Card Dispute User Pre-Arbitration Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_submitted`. Contains the details specific to a user prearbitration submitted Visa Card Dispute Network Event, which represents that the user's request for prearbitration has been submitted to the network.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Submitted Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute User Pre-Arbitration Submitted Visa Network Events", "nullable": true }, "user_prearbitration_timed_out": { "additionalProperties": false, "description": "A Card Dispute User Pre-Arbitration Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_timed_out`. Contains the details specific to a user prearbitration timed out Visa Card Dispute Network Event, which represents that the merchant has timed out responding to the user's prearbitration request.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Timed Out Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute User Pre-Arbitration Timed Out Visa Network Events", "nullable": true }, "user_withdrawal_submitted": { "additionalProperties": false, "description": "A Card Dispute User Withdrawal Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_withdrawal_submitted`. Contains the details specific to a user withdrawal submitted Visa Card Dispute Network Event, which represents that the user's request to withdraw the dispute has been submitted to the network.", "example": {}, "properties": {}, "title": "Visa Card Dispute Network Event Card Dispute User Withdrawal Submitted Visa Network Event", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute User Withdrawal Submitted Visa Network Events", "nullable": true } }, "required": [ "created_at", "attachment_files", "dispute_financial_transaction_id", "category" ], "title": "Visa Card Dispute Network Event", "type": "object", "x-event-categories": [], "x-title-plural": "Visa Card Dispute Network Events" }, "card_dispute_visa_user_submission": { "additionalProperties": false, "properties": { "accepted_at": { "description": "The date and time at which the Visa Card Dispute User Submission was reviewed and accepted.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "amount": { "description": "The amount of the dispute if it is different from the amount of a prior user submission or the disputed transaction.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "attachment_files": { "description": "The files attached to the Visa Card Dispute User Submission.", "items": { "$ref": "#/components/schemas/card_dispute_file_attachment" }, "type": "array", "x-documentation-priority": "default" }, "category": { "description": "The category of the user submission. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "chargeback", "merchant_prearbitration_decline", "user_prearbitration" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa Card Dispute Chargeback User Submission Chargeback Details: details will be under the `chargeback` object.", "Visa Card Dispute Merchant Pre-Arbitration Decline User Submission: details will be under the `merchant_prearbitration_decline` object.", "Visa Card Dispute User-Initiated Pre-Arbitration User Submission: details will be under the `user_prearbitration` object." ] }, "chargeback": { "additionalProperties": false, "description": "A Visa Card Dispute Chargeback User Submission Chargeback Details object. This field will be present in the JSON response if and only if `category` is equal to `chargeback`. Contains the details specific to a Visa chargeback User Submission for a Card Dispute.", "example": { "authorization": null, "category": "fraud", "consumer_canceled_merchandise": null, "consumer_canceled_recurring_transaction": null, "consumer_canceled_services": null, "consumer_counterfeit_merchandise": null, "consumer_credit_not_processed": null, "consumer_damaged_or_defective_merchandise": null, "consumer_merchandise_misrepresentation": null, "consumer_merchandise_not_as_described": null, "consumer_merchandise_not_received": null, "consumer_non_receipt_of_cash": null, "consumer_original_credit_transaction_not_accepted": null, "consumer_quality_merchandise": null, "consumer_quality_services": null, "consumer_services_misrepresentation": null, "consumer_services_not_as_described": null, "consumer_services_not_received": null, "fraud": { "fraud_type": "lost" }, "processing_error": null }, "properties": { "authorization": { "additionalProperties": false, "description": "Authorization. Present if and only if `category` is `authorization`.", "properties": { "account_status": { "description": "Account status.", "enum": [ "account_closed", "credit_problem", "fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account closed.", "Credit problem.", "Fraud." ] } }, "required": [ "account_status" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Authorization", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Authorizations", "nullable": true }, "category": { "description": "Category.", "enum": [ "authorization", "consumer_canceled_merchandise", "consumer_canceled_recurring_transaction", "consumer_canceled_services", "consumer_counterfeit_merchandise", "consumer_credit_not_processed", "consumer_damaged_or_defective_merchandise", "consumer_merchandise_misrepresentation", "consumer_merchandise_not_as_described", "consumer_merchandise_not_received", "consumer_non_receipt_of_cash", "consumer_original_credit_transaction_not_accepted", "consumer_quality_merchandise", "consumer_quality_services", "consumer_services_misrepresentation", "consumer_services_not_as_described", "consumer_services_not_received", "fraud", "processing_error" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Authorization.", "Consumer: canceled merchandise.", "Consumer: canceled recurring transaction.", "Consumer: canceled services.", "Consumer: counterfeit merchandise.", "Consumer: credit not processed.", "Consumer: damaged or defective merchandise.", "Consumer: merchandise misrepresentation.", "Consumer: merchandise not as described.", "Consumer: merchandise not received.", "Consumer: non-receipt of cash.", "Consumer: Original Credit Transaction (OCT) not accepted.", "Consumer: merchandise quality issue.", "Consumer: services quality issue.", "Consumer: services misrepresentation.", "Consumer: services not as described.", "Consumer: services not received.", "Fraud.", "Processing error." ] }, "consumer_canceled_merchandise": { "additionalProperties": false, "description": "Canceled merchandise. Present if and only if `category` is `consumer_canceled_merchandise`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "canceled_prior_to_ship_date": { "description": "Canceled prior to ship date.", "enum": [ "canceled_prior_to_ship_date", "not_canceled_prior_to_ship_date" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Canceled prior to ship date.", "Not canceled prior to ship date." ] }, "cancellation_policy_provided": { "description": "Cancellation policy provided.", "enum": [ "not_provided", "provided" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not provided.", "Provided." ] }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at", "canceled_prior_to_ship_date", "cancellation_policy_provided", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Cardholder Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellations", "nullable": true }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Present if and only if `return_outcome` is `not_returned`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Not Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Not Returneds", "nullable": true }, "purchase_explanation": { "description": "Purchase explanation.", "type": "string", "x-documentation-priority": "default" }, "received_or_expected_at": { "description": "Received or expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Present if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Return Attempted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Return Attempteds", "nullable": true }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Present if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "merchant_received_return_at", "other_explanation", "return_method", "returned_at", "tracking_number" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Returneds", "nullable": true } }, "required": [ "cardholder_cancellation", "merchant_resolution_attempted", "not_returned", "purchase_explanation", "received_or_expected_at", "return_attempted", "return_outcome", "returned" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Canceled Merchandises", "nullable": true }, "consumer_canceled_recurring_transaction": { "additionalProperties": false, "description": "Canceled recurring transaction. Present if and only if `category` is `consumer_canceled_recurring_transaction`.", "properties": { "cancellation_target": { "description": "Cancellation target.", "enum": [ "account", "transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account.", "Transaction." ] }, "merchant_contact_methods": { "additionalProperties": false, "description": "Merchant contact methods.", "properties": { "application_name": { "description": "Application name.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "call_center_phone_number": { "description": "Call center phone number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "email_address": { "description": "Email address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "in_person_address": { "description": "In person address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "mailing_address": { "description": "Mailing address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "text_phone_number": { "description": "Text phone number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "application_name", "call_center_phone_number", "email_address", "in_person_address", "mailing_address", "text_phone_number" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Recurring Transaction Merchant Contact Methods", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Merchant Contact Methods" }, "other_form_of_payment_explanation": { "description": "Other form of payment explanation.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_or_account_canceled_at": { "description": "Transaction or account canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_target", "merchant_contact_methods", "other_form_of_payment_explanation", "transaction_or_account_canceled_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Recurring Transaction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Canceled Recurring Transactions", "nullable": true }, "consumer_canceled_services": { "additionalProperties": false, "description": "Canceled services. Present if and only if `category` is `consumer_canceled_services`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "cancellation_policy_provided": { "description": "Cancellation policy provided.", "enum": [ "not_provided", "provided" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not provided.", "Provided." ] }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at", "cancellation_policy_provided", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Cardholder Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellations" }, "contracted_at": { "description": "Contracted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "guaranteed_reservation": { "additionalProperties": false, "description": "Guaranteed reservation explanation. Present if and only if `service_type` is `guaranteed_reservation`.", "properties": { "explanation": { "description": "Explanation.", "enum": [ "cardholder_canceled_prior_to_service", "cardholder_cancellation_attempt_within_24_hours_of_confirmation", "merchant_billed_no_show" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder canceled prior to service.", "Cardholder cancellation attempt within 24 hours of confirmation.", "Merchant billed for no-show." ] } }, "required": [ "explanation" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Guaranteed Reservation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Guaranteed Reservations", "nullable": true }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "other": { "additionalProperties": false, "description": "Other service type explanation. Present if and only if `service_type` is `other`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Other", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Others", "nullable": true }, "purchase_explanation": { "description": "Purchase explanation.", "type": "string", "x-documentation-priority": "default" }, "service_type": { "description": "Service type.", "enum": [ "guaranteed_reservation", "other", "timeshare" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Guaranteed reservation.", "Other.", "Timeshare." ] }, "timeshare": { "additionalProperties": false, "description": "Timeshare explanation. Present if and only if `service_type` is `timeshare`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Timeshare", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Timeshares", "nullable": true } }, "required": [ "cardholder_cancellation", "contracted_at", "guaranteed_reservation", "merchant_resolution_attempted", "other", "purchase_explanation", "service_type", "timeshare" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Canceled Services", "nullable": true }, "consumer_counterfeit_merchandise": { "additionalProperties": false, "description": "Counterfeit merchandise. Present if and only if `category` is `consumer_counterfeit_merchandise`.", "properties": { "counterfeit_explanation": { "description": "Counterfeit explanation.", "type": "string", "x-documentation-priority": "default" }, "disposition_explanation": { "description": "Disposition explanation.", "type": "string", "x-documentation-priority": "default" }, "order_explanation": { "description": "Order explanation.", "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "counterfeit_explanation", "disposition_explanation", "order_explanation", "received_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Counterfeit Merchandise", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Counterfeit Merchandises", "nullable": true }, "consumer_credit_not_processed": { "additionalProperties": false, "description": "Credit not processed. Present if and only if `category` is `consumer_credit_not_processed`.", "properties": { "canceled_or_returned_at": { "description": "Canceled or returned at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "credit_expected_at": { "description": "Credit expected at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_or_returned_at", "credit_expected_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Credit Not Processed", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Credit Not Processeds", "nullable": true }, "consumer_damaged_or_defective_merchandise": { "additionalProperties": false, "description": "Damaged or defective merchandise. Present if and only if `category` is `consumer_damaged_or_defective_merchandise`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Present if and only if `return_outcome` is `not_returned`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Not Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Not Returneds", "nullable": true }, "order_and_issue_explanation": { "description": "Order and issue explanation.", "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Present if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Return Attempted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Return Attempteds", "nullable": true }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Present if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "merchant_received_return_at", "other_explanation", "return_method", "returned_at", "tracking_number" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Returneds", "nullable": true } }, "required": [ "merchant_resolution_attempted", "not_returned", "order_and_issue_explanation", "received_at", "return_attempted", "return_outcome", "returned" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Damaged Or Defective Merchandises", "nullable": true }, "consumer_merchandise_misrepresentation": { "additionalProperties": false, "description": "Merchandise misrepresentation. Present if and only if `category` is `consumer_merchandise_misrepresentation`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "misrepresentation_explanation": { "description": "Misrepresentation explanation.", "type": "string", "x-documentation-priority": "default" }, "not_returned": { "additionalProperties": false, "description": "Not returned. Present if and only if `return_outcome` is `not_returned`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Not Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Not Returneds", "nullable": true }, "purchase_explanation": { "description": "Purchase explanation.", "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Present if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Return Attempted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Return Attempteds", "nullable": true }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Present if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "merchant_received_return_at", "other_explanation", "return_method", "returned_at", "tracking_number" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Returneds", "nullable": true } }, "required": [ "merchant_resolution_attempted", "misrepresentation_explanation", "not_returned", "purchase_explanation", "received_at", "return_attempted", "return_outcome", "returned" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Merchandise Misrepresentations", "nullable": true }, "consumer_merchandise_not_as_described": { "additionalProperties": false, "description": "Merchandise not as described. Present if and only if `category` is `consumer_merchandise_not_as_described`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Present if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described Return Attempted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Return Attempteds", "nullable": true }, "return_outcome": { "description": "Return outcome.", "enum": [ "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Present if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "merchant_received_return_at", "other_explanation", "return_method", "returned_at", "tracking_number" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Returneds", "nullable": true } }, "required": [ "merchant_resolution_attempted", "received_at", "return_attempted", "return_outcome", "returned" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Merchandise Not As Describeds", "nullable": true }, "consumer_merchandise_not_received": { "additionalProperties": false, "description": "Merchandise not received. Present if and only if `category` is `consumer_merchandise_not_received`.", "properties": { "cancellation_outcome": { "description": "Cancellation outcome.", "enum": [ "cardholder_cancellation_prior_to_expected_receipt", "merchant_cancellation", "no_cancellation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder cancellation prior to expected receipt.", "Merchant cancellation.", "No cancellation." ] }, "cardholder_cancellation_prior_to_expected_receipt": { "additionalProperties": false, "description": "Cardholder cancellation prior to expected receipt. Present if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Cardholder Cancellation Prior To Expected Receipt", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellation Prior To Expected Receipts", "nullable": true }, "delayed": { "additionalProperties": false, "description": "Delayed. Present if and only if `delivery_issue` is `delayed`.", "properties": { "explanation": { "description": "Explanation.", "type": "string", "x-documentation-priority": "default" }, "not_returned": { "additionalProperties": false, "description": "Not returned. Present if and only if `return_outcome` is `not_returned`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Not Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Not Returneds", "nullable": true }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Present if and only if `return_outcome` is `return_attempted`.", "properties": { "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempted_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Return Attempted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Return Attempteds", "nullable": true }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Present if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "merchant_received_return_at", "returned_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Returneds", "nullable": true } }, "required": [ "explanation", "not_returned", "return_attempted", "return_outcome", "returned" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Delayeds", "nullable": true }, "delivered_to_wrong_location": { "additionalProperties": false, "description": "Delivered to wrong location. Present if and only if `delivery_issue` is `delivered_to_wrong_location`.", "properties": { "agreed_location": { "description": "Agreed location.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "agreed_location" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delivered To Wrong Location", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Delivered To Wrong Locations", "nullable": true }, "delivery_issue": { "description": "Delivery issue.", "enum": [ "delayed", "delivered_to_wrong_location" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Delayed.", "Delivered to wrong location." ] }, "last_expected_receipt_at": { "description": "Last expected receipt at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_cancellation": { "additionalProperties": false, "description": "Merchant cancellation. Present if and only if `cancellation_outcome` is `merchant_cancellation`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Merchant Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Merchant Cancellations", "nullable": true }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "no_cancellation": { "additionalProperties": false, "description": "No cancellation. Present if and only if `cancellation_outcome` is `no_cancellation`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received No Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "No Cancellations", "nullable": true }, "purchase_info_and_explanation": { "description": "Purchase information and explanation.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_outcome", "cardholder_cancellation_prior_to_expected_receipt", "delayed", "delivered_to_wrong_location", "delivery_issue", "last_expected_receipt_at", "merchant_cancellation", "merchant_resolution_attempted", "no_cancellation", "purchase_info_and_explanation" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Merchandise Not Receiveds", "nullable": true }, "consumer_non_receipt_of_cash": { "additionalProperties": false, "description": "Non-receipt of cash. Present if and only if `category` is `consumer_non_receipt_of_cash`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Non Receipt Of Cash", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Non Receipt Of Cashes", "nullable": true }, "consumer_original_credit_transaction_not_accepted": { "additionalProperties": false, "description": "Original Credit Transaction (OCT) not accepted. Present if and only if `category` is `consumer_original_credit_transaction_not_accepted`.", "properties": { "explanation": { "description": "Explanation.", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "enum": [ "prohibited_by_local_laws_or_regulation", "recipient_refused" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Prohibited by local laws or regulation.", "Recipient refused." ] } }, "required": [ "explanation", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Original Credit Transaction Not Accepted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Original Credit Transaction Not Accepteds", "nullable": true }, "consumer_quality_merchandise": { "additionalProperties": false, "description": "Merchandise quality issue. Present if and only if `category` is `consumer_quality_merchandise`.", "properties": { "expected_at": { "description": "Expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Present if and only if `return_outcome` is `not_returned`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Not Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Not Returneds", "nullable": true }, "ongoing_negotiations": { "additionalProperties": false, "description": "Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations.", "properties": { "explanation": { "description": "Explanation of the previous ongoing negotiations between the cardholder and merchant.", "type": "string", "x-documentation-priority": "default" }, "issuer_first_notified_at": { "description": "Date the cardholder first notified the issuer of the dispute.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "started_at": { "description": "Started at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "issuer_first_notified_at", "started_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Ongoing Negotiations", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Ongoing Negotiations", "nullable": true }, "purchase_info_and_quality_issue": { "description": "Purchase information and quality issue.", "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Present if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Return Attempted", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Return Attempteds", "nullable": true }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Present if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "merchant_received_return_at", "other_explanation", "return_method", "returned_at", "tracking_number" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Returned", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Returneds", "nullable": true } }, "required": [ "expected_at", "merchant_resolution_attempted", "not_returned", "ongoing_negotiations", "purchase_info_and_quality_issue", "received_at", "return_attempted", "return_outcome", "returned" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Quality Merchandises", "nullable": true }, "consumer_quality_services": { "additionalProperties": false, "description": "Services quality issue. Present if and only if `category` is `consumer_quality_services`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services Cardholder Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellations" }, "cardholder_paid_to_have_work_redone": { "description": "Cardholder paid to have work redone.", "enum": [ "did_not_pay_to_have_work_redone", "paid_to_have_work_redone" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder did not pay to have work redone.", "Cardholder paid to have work redone." ], "nullable": true }, "non_fiat_currency_or_non_fungible_token_related_and_not_matching_description": { "description": "Non-fiat currency or non-fungible token related and not matching description.", "enum": [ "not_related", "related" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not related.", "Related." ] }, "ongoing_negotiations": { "additionalProperties": false, "description": "Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations.", "properties": { "explanation": { "description": "Explanation of the previous ongoing negotiations between the cardholder and merchant.", "type": "string", "x-documentation-priority": "default" }, "issuer_first_notified_at": { "description": "Date the cardholder first notified the issuer of the dispute.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "started_at": { "description": "Started at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "issuer_first_notified_at", "started_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services Ongoing Negotiations", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Ongoing Negotiations", "nullable": true }, "purchase_info_and_quality_issue": { "description": "Purchase information and quality issue.", "type": "string", "x-documentation-priority": "default" }, "restaurant_food_related": { "description": "Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814.", "enum": [ "not_related", "related" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not related.", "Related." ], "nullable": true }, "services_received_at": { "description": "Services received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "cardholder_paid_to_have_work_redone", "non_fiat_currency_or_non_fungible_token_related_and_not_matching_description", "ongoing_negotiations", "purchase_info_and_quality_issue", "restaurant_food_related", "services_received_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Quality Services", "nullable": true }, "consumer_services_misrepresentation": { "additionalProperties": false, "description": "Services misrepresentation. Present if and only if `category` is `consumer_services_misrepresentation`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Misrepresentation Cardholder Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellations" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "misrepresentation_explanation": { "description": "Misrepresentation explanation.", "type": "string", "x-documentation-priority": "default" }, "purchase_explanation": { "description": "Purchase explanation.", "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "merchant_resolution_attempted", "misrepresentation_explanation", "purchase_explanation", "received_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Misrepresentation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Services Misrepresentations", "nullable": true }, "consumer_services_not_as_described": { "additionalProperties": false, "description": "Services not as described. Present if and only if `category` is `consumer_services_not_as_described`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not As Described Cardholder Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellations" }, "explanation": { "description": "Explanation of what was ordered and was not as described.", "type": "string", "x-documentation-priority": "default" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "explanation", "merchant_resolution_attempted", "received_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not As Described", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Services Not As Describeds", "nullable": true }, "consumer_services_not_received": { "additionalProperties": false, "description": "Services not received. Present if and only if `category` is `consumer_services_not_received`.", "properties": { "cancellation_outcome": { "description": "Cancellation outcome.", "enum": [ "cardholder_cancellation_prior_to_expected_receipt", "merchant_cancellation", "no_cancellation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder cancellation prior to expected receipt.", "Merchant cancellation.", "No cancellation." ] }, "cardholder_cancellation_prior_to_expected_receipt": { "additionalProperties": false, "description": "Cardholder cancellation prior to expected receipt. Present if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received Cardholder Cancellation Prior To Expected Receipt", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholder Cancellation Prior To Expected Receipts", "nullable": true }, "last_expected_receipt_at": { "description": "Last expected receipt at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_cancellation": { "additionalProperties": false, "description": "Merchant cancellation. Present if and only if `cancellation_outcome` is `merchant_cancellation`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received Merchant Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Merchant Cancellations", "nullable": true }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "no_cancellation": { "additionalProperties": false, "description": "No cancellation. Present if and only if `cancellation_outcome` is `no_cancellation`.", "properties": {}, "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received No Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "No Cancellations", "nullable": true }, "purchase_info_and_explanation": { "description": "Purchase information and explanation.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_outcome", "cardholder_cancellation_prior_to_expected_receipt", "last_expected_receipt_at", "merchant_cancellation", "merchant_resolution_attempted", "no_cancellation", "purchase_info_and_explanation" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Consumer Services Not Receiveds", "nullable": true }, "fraud": { "additionalProperties": false, "description": "Fraud. Present if and only if `category` is `fraud`.", "properties": { "fraud_type": { "description": "Fraud type.", "enum": [ "account_or_credentials_takeover", "card_not_received_as_issued", "fraudulent_application", "fraudulent_use_of_account_number", "incorrect_processing", "issuer_reported_counterfeit", "lost", "manipulation_of_account_holder", "merchant_misrepresentation", "miscellaneous", "stolen" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account or credentials takeover.", "Card not received as issued.", "Fraudulent application.", "Fraudulent use of account number.", "Incorrect processing.", "Issuer reported counterfeit.", "Lost.", "Manipulation of account holder.", "Merchant misrepresentation.", "Miscellaneous.", "Stolen." ] } }, "required": [ "fraud_type" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Fraud", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Frauds", "nullable": true }, "processing_error": { "additionalProperties": false, "description": "Processing error. Present if and only if `category` is `processing_error`.", "properties": { "duplicate_transaction": { "additionalProperties": false, "description": "Duplicate transaction. Present if and only if `error_reason` is `duplicate_transaction`.", "properties": { "other_transaction_id": { "description": "Other transaction ID.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "other_transaction_id" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Duplicate Transaction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Duplicate Transactions", "nullable": true }, "error_reason": { "description": "Error reason.", "enum": [ "duplicate_transaction", "incorrect_amount", "paid_by_other_means" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Duplicate transaction.", "Incorrect amount.", "Paid by other means." ] }, "incorrect_amount": { "additionalProperties": false, "description": "Incorrect amount. Present if and only if `error_reason` is `incorrect_amount`.", "properties": { "expected_amount": { "description": "Expected amount.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "expected_amount" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Incorrect Amount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Incorrect Amounts", "nullable": true }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "paid_by_other_means": { "additionalProperties": false, "description": "Paid by other means. Present if and only if `error_reason` is `paid_by_other_means`.", "properties": { "other_form_of_payment_evidence": { "description": "Other form of payment evidence.", "enum": [ "canceled_check", "card_transaction", "cash_receipt", "other", "statement", "voucher" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Canceled check.", "Card transaction.", "Cash receipt.", "Other.", "Statement.", "Voucher." ] }, "other_transaction_id": { "description": "Other transaction ID.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "other_form_of_payment_evidence", "other_transaction_id" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Paid By Other Means", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Paid By Other Means", "nullable": true } }, "required": [ "duplicate_transaction", "error_reason", "incorrect_amount", "merchant_resolution_attempted", "paid_by_other_means" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Processing Errors", "nullable": true } }, "required": [ "authorization", "category", "consumer_canceled_merchandise", "consumer_canceled_recurring_transaction", "consumer_canceled_services", "consumer_counterfeit_merchandise", "consumer_credit_not_processed", "consumer_damaged_or_defective_merchandise", "consumer_merchandise_misrepresentation", "consumer_merchandise_not_as_described", "consumer_merchandise_not_received", "consumer_non_receipt_of_cash", "consumer_original_credit_transaction_not_accepted", "consumer_quality_merchandise", "consumer_quality_services", "consumer_services_misrepresentation", "consumer_services_not_as_described", "consumer_services_not_received", "fraud", "processing_error" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visa Card Dispute Chargeback User Submission Chargeback Details", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute User Submission was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "explanation": { "description": "The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "further_information_requested_at": { "description": "The date and time at which Increase requested further information from the user for the Visa Card Dispute.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "further_information_requested_reason": { "description": "The reason for Increase requesting further information from the user for the Visa Card Dispute.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_prearbitration_decline": { "additionalProperties": false, "description": "A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_decline`. Contains the details specific to a merchant prearbitration decline Visa Card Dispute User Submission.", "example": { "reason": "I do not believe the explanation given by the merchant is valid." }, "properties": { "reason": { "description": "The reason the user declined the merchant's request for pre-arbitration in their favor.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute Merchant Pre-Arbitration Decline User Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visa Card Dispute Merchant Pre-Arbitration Decline User Submissions", "nullable": true }, "status": { "description": "The status of the Visa Card Dispute User Submission.", "enum": [ "abandoned", "accepted", "further_information_requested", "pending_reviewing" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The User Submission was abandoned.", "The User Submission was accepted.", "Further information is requested, please resubmit with the requested information.", "The User Submission is pending review." ] }, "updated_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute User Submission was updated.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "user_prearbitration": { "additionalProperties": false, "description": "A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration`. Contains the details specific to a user-initiated pre-arbitration Visa Card Dispute User Submission.", "example": { "category_change": { "category": "fraud", "reason": "Based on the response from the merchant." }, "reason": "I disagree with the explanation given by the merchant." }, "properties": { "category_change": { "additionalProperties": false, "description": "Category change details for the pre-arbitration request, if requested.", "properties": { "category": { "description": "The category the dispute is being changed to.", "enum": [ "authorization", "consumer_canceled_merchandise", "consumer_canceled_recurring_transaction", "consumer_canceled_services", "consumer_counterfeit_merchandise", "consumer_credit_not_processed", "consumer_damaged_or_defective_merchandise", "consumer_merchandise_misrepresentation", "consumer_merchandise_not_as_described", "consumer_merchandise_not_received", "consumer_non_receipt_of_cash", "consumer_original_credit_transaction_not_accepted", "consumer_quality_merchandise", "consumer_quality_services", "consumer_services_misrepresentation", "consumer_services_not_as_described", "consumer_services_not_received", "fraud", "processing_error" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Authorization.", "Consumer: canceled merchandise.", "Consumer: canceled recurring transaction.", "Consumer: canceled services.", "Consumer: counterfeit merchandise.", "Consumer: credit not processed.", "Consumer: damaged or defective merchandise.", "Consumer: merchandise misrepresentation.", "Consumer: merchandise not as described.", "Consumer: merchandise not received.", "Consumer: non-receipt of cash.", "Consumer: Original Credit Transaction (OCT) not accepted.", "Consumer: merchandise quality issue.", "Consumer: services quality issue.", "Consumer: services misrepresentation.", "Consumer: services not as described.", "Consumer: services not received.", "Fraud.", "Processing error." ] }, "reason": { "description": "The reason for the pre-arbitration request.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "category", "reason" ], "title": "Visa Card Dispute User Submission Visa Card Dispute User-Initiated Pre-Arbitration User Submission Category Change", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Category Changes", "nullable": true }, "reason": { "description": "The reason for the pre-arbitration request.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "reason", "category_change" ], "title": "Visa Card Dispute User Submission Visa Card Dispute User-Initiated Pre-Arbitration User Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visa Card Dispute User-Initiated Pre-Arbitration User Submissions", "nullable": true } }, "required": [ "created_at", "updated_at", "amount", "explanation", "attachment_files", "status", "accepted_at", "further_information_requested_at", "further_information_requested_reason", "category" ], "title": "Visa Card Dispute User Submission", "type": "object", "x-event-categories": [], "x-title-plural": "Visa Card Dispute User Submissions" }, "card_financial": { "additionalProperties": true, "description": "Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction.", "example": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "id": "card_financial_di5b98i72ppomo268zfk", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_financial", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "properties": { "actioner": { "description": "Whether this financial was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.", "enum": [ "user", "increase", "network" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This object was actioned by the user through a real-time decision.", "This object was actioned by Increase without user intervention.", "This object was actioned by the network, through stand-in processing." ] }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Financial AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Card Financial AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "amount": { "description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "direction": { "description": "The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.", "enum": [ "settlement", "refund" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regular card authorization where funds are debited from the cardholder.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder." ] }, "id": { "description": "The Card Financial identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Financials" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Card Financial NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Card Financial NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Card Financial NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Financial NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "presentment_amount": { "description": "The pending amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "processing_category": { "description": "The processing category describes the intent behind the financial, such as whether it was used for bill payments or an automatic fuel dispenser.", "enum": [ "account_funding", "automatic_fuel_dispenser", "bill_payment", "original_credit", "purchase", "quasi_cash", "refund", "cash_disbursement", "balance_inquiry", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.", "Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.", "A transaction used to pay a bill.", "Original credit transactions are used to send money to a cardholder.", "A regular purchase.", "Quasi-cash transactions represent purchases of items which may be convertible to cash.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.", "Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.", "A balance inquiry transaction is used to check the balance of an account associated with a card.", "The processing category is unknown." ] }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card financial.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Financial Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "The identifier of the Transaction associated with this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_financial`.", "enum": [ "card_financial" ], "type": "string", "x-documentation-priority": "default" }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Card Financial Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Card Financial Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Card Financial Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Card Financial Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "type", "id", "card_payment_id", "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "amount", "presentment_amount", "presentment_currency", "currency", "direction", "actioner", "processing_category", "real_time_decision_id", "transaction_id", "scheme_fees" ], "title": "Card Financial", "type": "object", "x-event-categories": [], "x-title-plural": "Card Financials" }, "card_fuel_confirmation": { "additionalProperties": true, "description": "Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed.", "example": { "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_fuel_confirmation_wuy91qate4judq2la80a", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "type": "card_fuel_confirmation", "updated_authorization_amount": 120 }, "properties": { "card_authorization_id": { "description": "The identifier for the Card Authorization this updates.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "id": { "description": "The Card Fuel Confirmation identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Fuel Confirmations" }, "network": { "description": "The card network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Fuel Confirmation NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction associated with this Card Fuel Confirmation.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card fuel confirmation.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Fuel Confirmation Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_fuel_confirmation`.", "enum": [ "card_fuel_confirmation" ], "type": "string", "x-documentation-priority": "default" }, "updated_authorization_amount": { "description": "The updated authorization amount after this fuel confirmation, in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "type", "id", "updated_authorization_amount", "currency", "card_authorization_id", "network", "pending_transaction_id", "network_identifiers", "scheme_fees" ], "title": "Card Fuel Confirmation", "type": "object", "x-event-categories": [], "x-title-plural": "Card Fuel Confirmations" }, "card_iframe_url": { "additionalProperties": false, "description": "An object containing the iframe URL for a Card.", "example": { "expires_at": "2020-01-31T23:59:59Z", "iframe_url": "https://increase.com/card_details_iframe/index.html?token=0", "type": "card_iframe_url" }, "properties": { "expires_at": { "description": "The time the iframe URL will expire.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "iframe_url": { "description": "The iframe URL for the Card. Treat this as an opaque URL.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_iframe_url`.", "enum": [ "card_iframe_url" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "iframe_url", "expires_at" ], "title": "Card iframe URL", "type": "object", "x-event-categories": [], "x-title-plural": "Card iframe URLs" }, "card_increment": { "additionalProperties": true, "description": "Card Increments increase the pending amount of an authorized transaction.", "example": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": null, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 20, "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_increment_6ztayc58j1od0rpebp3e", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "presentment_amount": 20, "presentment_currency": "USD", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "type": "card_increment", "updated_authorization_amount": 120 }, "properties": { "actioner": { "description": "Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.", "enum": [ "user", "increase", "network" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This object was actioned by the user through a real-time decision.", "This object was actioned by Increase without user intervention.", "This object was actioned by the network, through stand-in processing." ] }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Increment AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Card Increment AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "amount": { "description": "The amount of this increment in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_authorization_id": { "description": "The identifier for the Card Authorization this increments.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "id": { "description": "The Card Increment identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Increments" }, "network": { "description": "The card network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Increment NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction associated with this Card Increment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "presentment_amount": { "description": "The amount of this increment in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this incremental authorization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card increment.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Increment Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_increment`.", "enum": [ "card_increment" ], "type": "string", "x-documentation-priority": "default" }, "updated_authorization_amount": { "description": "The updated authorization amount after this increment, in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "type", "id", "amount", "presentment_amount", "updated_authorization_amount", "currency", "presentment_currency", "card_authorization_id", "network", "actioner", "real_time_decision_id", "pending_transaction_id", "additional_amounts", "network_risk_score", "network_identifiers", "scheme_fees" ], "title": "Card Increment", "type": "object", "x-event-categories": [], "x-title-plural": "Card Increments" }, "card_list": { "additionalProperties": true, "description": "A list of Card objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "authorization_controls": null, "billing_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "created_at": "2020-01-31T23:59:59Z", "description": "Office Expenses", "digital_wallet": { "digital_card_profile_id": "digital_card_profile_s3puplu90f04xhcwkiga", "email": "user@example.com", "phone": "+16505046304" }, "entity_id": null, "expiration_month": 11, "expiration_year": 2028, "id": "card_oubs0hwk5rn6knuecxg2", "idempotency_key": null, "last4": "4242", "status": "active", "type": "card" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Lists" }, "card_payment": { "additionalProperties": false, "description": "Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "card_id": "card_oubs0hwk5rn6knuecxg2", "created_at": "2020-01-31T23:59:59Z", "digital_wallet_token_id": null, "elements": [ { "card_authorization": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "category": "card_authorization", "created_at": "2020-01-31T23:59:59Z" }, { "card_reversal": { "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_reversal_8vr9qy60cgf5d0slpb68", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "presentment_currency": "USD", "reversal_amount": 20, "reversal_presentment_amount": 20, "reversal_reason": "reversed_by_customer", "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_reversal", "updated_authorization_amount": 80, "updated_authorization_presentment_amount": 80 }, "category": "card_reversal", "created_at": "2020-01-31T23:59:59Z" }, { "card_increment": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": null, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 20, "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_increment_6ztayc58j1od0rpebp3e", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "presentment_amount": 20, "presentment_currency": "USD", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "type": "card_increment", "updated_authorization_amount": 120 }, "category": "card_increment", "created_at": "2020-01-31T23:59:59Z" }, { "card_settlement": { "amount": 100, "card_authorization": null, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_settlement_khv5kfeu0vndj291omg6", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "authorization_identification_response": "ABC123", "transaction_id": "627199945183184" }, "pending_transaction_id": null, "presentment_amount": 100, "presentment_currency": "USD", "purchase_details": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "surcharge": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_settlement" }, "category": "card_settlement", "created_at": "2020-01-31T23:59:59Z" } ], "id": "card_payment_nd3k2kacrqjli8482ave", "physical_card_id": null, "state": { "authorized_amount": 100, "fuel_confirmed_amount": 0, "incremented_amount": 20, "refund_authorized_amount": 0, "refunded_amount": 0, "reversed_amount": 20, "settled_amount": 100 }, "type": "card_payment" }, "properties": { "account_id": { "description": "The identifier for the Account the Transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "card_id": { "description": "The Card identifier for this payment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Payment was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "digital_wallet_token_id": { "description": "The Digital Wallet Token identifier for this payment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "elements": { "description": "The interactions related to this card payment.", "items": { "additionalProperties": false, "example": { "card_authorization": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "category": "card_authorization", "created_at": "2020-01-31T23:59:59Z" }, "properties": { "card_authentication": { "description": "A Card Authentication object. This field will be present in the JSON response if and only if `category` is equal to `card_authentication`. Card Authentications are attempts to authenticate a transaction or a card with 3DS.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_authentication" } ], "nullable": true }, "card_authorization": { "description": "A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`. Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_authorization" } ], "nullable": true }, "card_authorization_expiration": { "description": "A Card Authorization Expiration object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization_expiration`. Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_authorization_expiration" } ], "nullable": true }, "card_balance_inquiry": { "description": "A Card Balance Inquiry object. This field will be present in the JSON response if and only if `category` is equal to `card_balance_inquiry`. Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_balance_inquiry" } ], "nullable": true }, "card_decline": { "additionalProperties": true, "description": "A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.", "example": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": -1000, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "declined_transaction_id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "digital_wallet_token_id": null, "direction": "settlement", "id": "card_decline_bx3o8zd7glq8yvtwg25v", "incremented_card_authorization_id": null, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": null, "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "physical_card_id": null, "presentment_amount": -1000, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "real_time_decision_reason": null, "reason": "insufficient_funds", "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "properties": { "actioner": { "description": "Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.", "enum": [ "user", "increase", "network" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This object was actioned by the user through a real-time decision.", "This object was actioned by Increase without user intervention.", "This object was actioned by the network, through stand-in processing." ] }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Card Payment Card Payment Element Card Decline AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "amount": { "description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "declined_transaction_id": { "description": "The identifier of the declined transaction created for this Card Decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "direction": { "description": "The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.", "enum": [ "settlement", "refund" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regular card authorization where funds are debited from the cardholder.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder." ] }, "id": { "description": "The Card Decline identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Declines" }, "incremented_card_authorization_id": { "description": "The identifier of the card authorization this request attempted to incrementally authorize.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations", "nullable": true }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Card Payment Card Payment Element Card Decline NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Card Payment Card Payment Element Card Decline NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Card Payment Card Payment Element Card Decline NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Payment Card Payment Element Card Decline NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "presentment_amount": { "description": "The declined amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "processing_category": { "description": "The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.", "enum": [ "account_funding", "automatic_fuel_dispenser", "bill_payment", "original_credit", "purchase", "quasi_cash", "refund", "cash_disbursement", "balance_inquiry", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.", "Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.", "A transaction used to pay a bill.", "Original credit transactions are used to send money to a cardholder.", "A regular purchase.", "Quasi-cash transactions represent purchases of items which may be convertible to cash.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.", "Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.", "A balance inquiry transaction is used to check the balance of an account associated with a card.", "The processing category is unknown." ] }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "real_time_decision_reason": { "description": "This is present if a specific decline reason was given in the real-time decision.", "enum": [ "insufficient_funds", "transaction_never_allowed", "exceeds_approval_limit", "card_temporarily_disabled", "suspected_fraud", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again.", "This type of transaction is not allowed for this card. This transaction should not be retried.", "The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again.", "The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again.", "The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.", "The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly." ], "nullable": true }, "reason": { "description": "Why the transaction was declined.", "enum": [ "account_closed", "card_not_active", "card_canceled", "physical_card_not_active", "entity_not_active", "group_locked", "insufficient_funds", "cvv2_mismatch", "pin_mismatch", "card_expiration_mismatch", "transaction_not_allowed", "breaches_limit", "webhook_declined", "webhook_timed_out", "declined_by_stand_in_processing", "invalid_physical_card", "missing_original_authorization", "invalid_cryptogram", "failed_3ds_authentication", "suspected_card_testing", "suspected_fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account has been closed.", "The Card was not active.", "The Card has been canceled.", "The Physical Card was not active.", "The account's entity was not active.", "The account was inactive.", "The Card's Account did not have a sufficient available balance.", "The given CVV2 did not match the card's value.", "The given PIN did not match the card's value.", "The given expiration date did not match the card's value. Only applies when a CVV2 is present.", "The attempted card transaction is not allowed per Increase's terms.", "The transaction was blocked by a Limit.", "Your application declined the transaction via webhook.", "Your application webhook did not respond without the required timeout.", "Declined by stand-in processing.", "The card read had an invalid CVV or dCVV.", "The original card authorization for this incremental authorization does not exist.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The transaction was declined because the 3DS authentication failed.", "The transaction was suspected to be used by a card tester to test for valid card numbers.", "The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information." ] }, "scheme_fees": { "description": "The scheme fees associated with this card decline.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Payment Card Payment Element Card Decline Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Card Payment Card Payment Element Card Decline Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Card Payment Card Payment Element Card Decline Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Card Payment Card Payment Element Card Decline Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Card Payment Card Payment Element Card Decline Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "id", "card_payment_id", "amount", "presentment_amount", "presentment_currency", "currency", "processing_category", "reason", "real_time_decision_reason", "incremented_card_authorization_id", "actioner", "direction", "real_time_decision_id", "scheme_fees", "declined_transaction_id" ], "title": "Card Payment Card Payment Element Card Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Declines", "nullable": true }, "card_financial": { "description": "A Card Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_financial`. Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_financial" } ], "nullable": true }, "card_fuel_confirmation": { "description": "A Card Fuel Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_fuel_confirmation" } ], "nullable": true }, "card_increment": { "description": "A Card Increment object. This field will be present in the JSON response if and only if `category` is equal to `card_increment`. Card Increments increase the pending amount of an authorized transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_increment" } ], "nullable": true }, "card_refund": { "description": "A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`. Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_refund" } ], "nullable": true }, "card_reversal": { "description": "A Card Reversal object. This field will be present in the JSON response if and only if `category` is equal to `card_reversal`. Card Reversals cancel parts of or the entirety of an existing Card Authorization.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_reversal" } ], "nullable": true }, "card_settlement": { "description": "A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`. Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_settlement" } ], "nullable": true }, "card_validation": { "description": "An Inbound Card Validation object. This field will be present in the JSON response if and only if `category` is equal to `card_validation`. Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_card_validation" } ], "nullable": true }, "category": { "description": "The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "card_authorization", "card_authentication", "card_balance_inquiry", "card_validation", "card_decline", "card_reversal", "card_authorization_expiration", "card_increment", "card_settlement", "card_refund", "card_fuel_confirmation", "card_financial", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Card Authorization: details will be under the `card_authorization` object.", "Card Authentication: details will be under the `card_authentication` object.", "Card Balance Inquiry: details will be under the `card_balance_inquiry` object.", "Inbound Card Validation: details will be under the `card_validation` object.", "Card Decline: details will be under the `card_decline` object.", "Card Reversal: details will be under the `card_reversal` object.", "Card Authorization Expiration: details will be under the `card_authorization_expiration` object.", "Card Increment: details will be under the `card_increment` object.", "Card Settlement: details will be under the `card_settlement` object.", "Card Refund: details will be under the `card_refund` object.", "Card Fuel Confirmation: details will be under the `card_fuel_confirmation` object.", "Card Financial: details will be under the `card_financial` object.", "Unknown card payment element." ] }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card payment element was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null.", "properties": {}, "title": "Card Payment Card Payment Element Other", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Others", "nullable": true } }, "required": [ "category", "created_at" ], "title": "Card Payment Card Payment Element", "type": "object", "x-event-categories": [], "x-title-plural": "Card Payment Elements" }, "type": "array", "x-documentation-priority": "default" }, "id": { "description": "The Card Payment identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "physical_card_id": { "description": "The Physical Card identifier for this payment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "state": { "additionalProperties": false, "description": "The summarized state of this card payment.", "example": { "authorized_amount": 100, "fuel_confirmed_amount": 0, "incremented_amount": 20, "refund_authorized_amount": 0, "refunded_amount": 0, "reversed_amount": 20, "settled_amount": 100 }, "properties": { "authorized_amount": { "description": "The total authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "fuel_confirmed_amount": { "description": "The total amount from fuel confirmations in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "incremented_amount": { "description": "The total incrementally updated authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "refund_authorized_amount": { "description": "The total refund authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "refunded_amount": { "description": "The total refunded amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "reversed_amount": { "description": "The total reversed amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "settled_amount": { "description": "The total settled amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "authorized_amount", "refund_authorized_amount", "incremented_amount", "reversed_amount", "fuel_confirmed_amount", "settled_amount", "refunded_amount" ], "title": "Card Payment Card Payment State", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Payment States" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_payment`.", "enum": [ "card_payment" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "account_id", "card_id", "physical_card_id", "digital_wallet_token_id", "elements", "state" ], "title": "Card Payment", "type": "object", "x-event-categories": [ "card_payment.created", "card_payment.updated" ], "x-tag": "Card Payments", "x-title-plural": "Card Payments" }, "card_payment_list": { "additionalProperties": true, "description": "A list of Card Payment objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "card_id": "card_oubs0hwk5rn6knuecxg2", "created_at": "2020-01-31T23:59:59Z", "digital_wallet_token_id": null, "elements": [ { "card_authorization": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "category": "card_authorization", "created_at": "2020-01-31T23:59:59Z" }, { "card_reversal": { "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_reversal_8vr9qy60cgf5d0slpb68", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "presentment_currency": "USD", "reversal_amount": 20, "reversal_presentment_amount": 20, "reversal_reason": "reversed_by_customer", "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_reversal", "updated_authorization_amount": 80, "updated_authorization_presentment_amount": 80 }, "category": "card_reversal", "created_at": "2020-01-31T23:59:59Z" }, { "card_increment": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": null, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 20, "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_increment_6ztayc58j1od0rpebp3e", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "presentment_amount": 20, "presentment_currency": "USD", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "type": "card_increment", "updated_authorization_amount": 120 }, "category": "card_increment", "created_at": "2020-01-31T23:59:59Z" }, { "card_settlement": { "amount": 100, "card_authorization": null, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_settlement_khv5kfeu0vndj291omg6", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "authorization_identification_response": "ABC123", "transaction_id": "627199945183184" }, "pending_transaction_id": null, "presentment_amount": 100, "presentment_currency": "USD", "purchase_details": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "surcharge": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_settlement" }, "category": "card_settlement", "created_at": "2020-01-31T23:59:59Z" } ], "id": "card_payment_nd3k2kacrqjli8482ave", "physical_card_id": null, "state": { "authorized_amount": 100, "fuel_confirmed_amount": 0, "incremented_amount": 20, "refund_authorized_amount": 0, "refunded_amount": 0, "reversed_amount": 20, "settled_amount": 100 }, "type": "card_payment" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card_payment" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card Payment List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Payment Lists" }, "card_purchase_supplement": { "additionalProperties": true, "description": "Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.", "example": { "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "id": "card_purchase_supplement_ijuc45iym4jchnh2sfk3", "invoice": { "discount_amount": 100, "discount_currency": "USD", "discount_treatment_code": null, "duty_tax_amount": 200, "duty_tax_currency": "USD", "order_date": "2023-07-20", "shipping_amount": 300, "shipping_currency": "USD", "shipping_destination_country_code": "US", "shipping_destination_postal_code": "10045", "shipping_source_postal_code": "10045", "shipping_tax_amount": 400, "shipping_tax_currency": "USD", "shipping_tax_rate": "0.2", "tax_treatments": null, "unique_value_added_tax_invoice_reference": "12302" }, "line_items": [ { "detail_indicator": "normal", "discount_amount": null, "discount_currency": null, "discount_treatment_code": null, "id": "card_purchase_supplement_invoice_line_item_nf9760lz0apqy5retmqh", "item_commodity_code": "001", "item_descriptor": "Coffee", "item_quantity": "1.0", "product_code": "101", "sales_tax_amount": null, "sales_tax_currency": null, "sales_tax_rate": null, "total_amount": 500, "total_amount_currency": "USD", "unit_cost": "5.0", "unit_cost_currency": "USD", "unit_of_measure_code": "NMB" } ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_purchase_supplement" }, "properties": { "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments", "nullable": true }, "id": { "description": "The Card Purchase Supplement identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Purchase Supplements" }, "invoice": { "additionalProperties": false, "description": "Invoice-level information about the payment.", "properties": { "discount_amount": { "description": "Discount given to cardholder.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "discount_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "discount_treatment_code": { "description": "Indicates how the merchant applied the discount.", "enum": [ "no_invoice_level_discount_provided", "tax_calculated_on_post_discount_invoice_total", "tax_calculated_on_pre_discount_invoice_total" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No invoice level discount provided", "Tax calculated on post discount invoice total", "Tax calculated on pre discount invoice total" ], "nullable": true }, "duty_tax_amount": { "description": "Amount of duty taxes.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "duty_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "order_date": { "description": "Date the order was taken.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_amount": { "description": "The shipping cost.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "shipping_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping cost.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_destination_country_code": { "description": "Country code of the shipping destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_destination_postal_code": { "description": "Postal code of the shipping destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_source_postal_code": { "description": "Postal code of the location being shipped from.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_tax_amount": { "description": "Taxes paid for freight and shipping.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "shipping_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping tax.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_tax_rate": { "description": "Tax rate for freight and shipping.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "tax_treatments": { "description": "Indicates how the merchant applied taxes.", "enum": [ "no_tax_applies", "net_price_line_item_level", "net_price_invoice_level", "gross_price_line_item_level", "gross_price_invoice_level" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No tax applies", "Net price line item level", "Net price invoice level", "Gross price line item level", "Gross price invoice level" ], "nullable": true }, "unique_value_added_tax_invoice_reference": { "description": "Value added tax invoice reference number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "discount_amount", "discount_currency", "shipping_amount", "shipping_currency", "duty_tax_amount", "duty_tax_currency", "shipping_tax_amount", "shipping_tax_currency", "shipping_tax_rate", "shipping_destination_postal_code", "shipping_destination_country_code", "shipping_source_postal_code", "unique_value_added_tax_invoice_reference", "order_date", "discount_treatment_code", "tax_treatments" ], "title": "Card Purchase Supplement Invoice", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Invoices", "nullable": true }, "line_items": { "description": "Line item information, such as individual products purchased.", "items": { "additionalProperties": false, "properties": { "detail_indicator": { "description": "Indicates the type of line item.", "enum": [ "normal", "credit", "payment" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Normal", "Credit", "Purchase" ], "nullable": true }, "discount_amount": { "description": "Discount amount for this specific line item.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "discount_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "discount_treatment_code": { "description": "Indicates how the merchant applied the discount for this specific line item.", "enum": [ "no_line_item_level_discount_provided", "tax_calculated_on_post_discount_line_item_total", "tax_calculated_on_pre_discount_line_item_total" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No line item level discount provided", "Tax calculated on post discount line item total", "Tax calculated on pre discount line item total" ], "nullable": true }, "id": { "description": "The Card Purchase Supplement Line Item identifier.", "type": "string", "x-documentation-priority": "default" }, "item_commodity_code": { "description": "Code used to categorize the purchase item.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "item_descriptor": { "description": "Description of the purchase item.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "item_quantity": { "description": "The number of units of the product being purchased.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "product_code": { "description": "Code used to categorize the product being purchased.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "sales_tax_amount": { "description": "Sales tax amount for this line item.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "sales_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "sales_tax_rate": { "description": "Sales tax rate for this line item.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "total_amount": { "description": "Total amount of all line items.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_amount_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total amount.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unit_cost": { "description": "Cost of line item per unit of measure, in major units.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unit_cost_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unit_of_measure_code": { "description": "Code indicating unit of measure (gallons, etc.).", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "id", "item_commodity_code", "item_descriptor", "product_code", "item_quantity", "unit_of_measure_code", "unit_cost", "unit_cost_currency", "sales_tax_amount", "sales_tax_currency", "sales_tax_rate", "discount_amount", "discount_currency", "discount_treatment_code", "total_amount", "total_amount_currency", "detail_indicator" ], "title": "Card Purchase Supplement LineItemsElement", "type": "object", "x-event-categories": [], "x-title-plural": "LineItemsElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "The ID of the transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_purchase_supplement`.", "enum": [ "card_purchase_supplement" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "transaction_id", "card_payment_id", "invoice", "line_items" ], "title": "Card Purchase Supplement", "type": "object", "x-event-categories": [ "card_purchase_supplement.created" ], "x-tag": "Card Purchase Supplements", "x-title-plural": "Card Purchase Supplements" }, "card_purchase_supplement_list": { "additionalProperties": true, "description": "A list of Card Purchase Supplement objects.", "example": { "data": [ { "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "id": "card_purchase_supplement_ijuc45iym4jchnh2sfk3", "invoice": { "discount_amount": 100, "discount_currency": "USD", "discount_treatment_code": null, "duty_tax_amount": 200, "duty_tax_currency": "USD", "order_date": "2023-07-20", "shipping_amount": 300, "shipping_currency": "USD", "shipping_destination_country_code": "US", "shipping_destination_postal_code": "10045", "shipping_source_postal_code": "10045", "shipping_tax_amount": 400, "shipping_tax_currency": "USD", "shipping_tax_rate": "0.2", "tax_treatments": null, "unique_value_added_tax_invoice_reference": "12302" }, "line_items": [ { "detail_indicator": "normal", "discount_amount": null, "discount_currency": null, "discount_treatment_code": null, "id": "card_purchase_supplement_invoice_line_item_nf9760lz0apqy5retmqh", "item_commodity_code": "001", "item_descriptor": "Coffee", "item_quantity": "1.0", "product_code": "101", "sales_tax_amount": null, "sales_tax_currency": null, "sales_tax_rate": null, "total_amount": 500, "total_amount_currency": "USD", "unit_cost": "5.0", "unit_cost_currency": "USD", "unit_of_measure_code": "NMB" } ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_purchase_supplement" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card_purchase_supplement" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card Purchase Supplement List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Purchase Supplement Lists" }, "card_push_transfer": { "additionalProperties": true, "description": "Card Push Transfers send funds to a recipient's payment card in real-time.", "example": { "acceptance": null, "account_id": "account_in71c4amph0vgo2qllky", "approval": null, "business_application_identifier": "funds_disbursement", "cancellation": null, "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "decline": null, "id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye", "idempotency_key": null, "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_name_prefix": "Acme", "merchant_postal_code": "10045", "merchant_state": "NY", "presentment_amount": { "currency": "USD", "value": "12.34" }, "recipient_name": "Ian Crease", "route": "visa", "sender_address_city": "New York", "sender_address_line1": "33 Liberty Street", "sender_address_postal_code": "10045", "sender_address_state": "NY", "sender_name": "Ian Crease", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "pending_submission", "submission": null, "type": "card_push_transfer" }, "properties": { "acceptance": { "additionalProperties": false, "description": "If the transfer is accepted by the recipient bank, this will contain supplemental details.", "example": { "accepted_at": "2020-01-31T23:59:59Z", "authorization_identification_response": "ABCDEF", "card_verification_value2_result": null, "network_transaction_identifier": "841488484271872", "settlement_amount": 100 }, "properties": { "accepted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was accepted by the issuing bank.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "authorization_identification_response": { "description": "The authorization identification response from the issuing bank.", "type": "string", "x-documentation-priority": "default" }, "card_verification_value2_result": { "description": "The result of the Card Verification Value 2 match.", "enum": [ "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Card Verification Value 2 (CVV2) matches the expected value.", "The Card Verification Value 2 (CVV2) does not match the expected value." ], "nullable": true }, "network_transaction_identifier": { "description": "A unique identifier for the transaction on the card network.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "settlement_amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "accepted_at", "settlement_amount", "authorization_identification_response", "network_transaction_identifier", "card_verification_value2_result" ], "title": "Card Push Transfer Card Push Transfer Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Push Transfer Acceptances", "nullable": true }, "account_id": { "description": "The Account from which the transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "approval": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.", "example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "properties": { "approved_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "approved_by": { "description": "If the Transfer was approved by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "approved_at", "approved_by" ], "title": "Card Push Transfer Transfer Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Approvals", "nullable": true }, "business_application_identifier": { "description": "The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it.", "enum": [ "account_to_account", "business_to_business", "money_transfer_bank_initiated", "non_card_bill_payment", "consumer_bill_payment", "card_bill_payment", "funds_disbursement", "funds_transfer", "loyalty_and_offers", "merchant_disbursement", "merchant_payment", "person_to_person", "top_up", "wallet_transfer" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account to Account", "Business to Business", "Money Transfer Bank Initiated", "Non-Card Bill Payment", "Consumer Bill Payment", "Card Bill Payment", "Funds Disbursement", "Funds Transfer", "Loyalty and Offers", "Merchant Disbursement", "Merchant Payment", "Person to Person", "Top Up", "Wallet Transfer" ] }, "cancellation": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.", "example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null }, "properties": { "canceled_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "canceled_by": { "description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "canceled_by" ], "title": "Card Push Transfer Transfer Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Cancellations", "nullable": true }, "card_token_id": { "description": "The ID of the Card Token that was used to validate the card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Card Push Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Card Push Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Card Push Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Card Push Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "decline": { "additionalProperties": false, "description": "If the transfer is rejected by the card network or the destination financial institution, this will contain supplemental details.", "example": { "declined_at": "2020-01-31T23:59:59Z", "network_transaction_identifier": "841488484271872", "reason": "transaction_not_permitted_to_cardholder" }, "properties": { "declined_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer declined.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "network_transaction_identifier": { "description": "A unique identifier for the transaction on the card network.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reason": { "description": "The reason why the transfer was declined.", "enum": [ "do_not_honor", "activity_count_limit_exceeded", "refer_to_card_issuer", "refer_to_card_issuer_special_condition", "invalid_merchant", "pick_up_card", "error", "pick_up_card_special", "invalid_transaction", "invalid_amount", "invalid_account_number", "no_such_issuer", "re_enter_transaction", "no_credit_account", "pick_up_card_lost", "pick_up_card_stolen", "closed_account", "insufficient_funds", "no_checking_account", "no_savings_account", "expired_card", "transaction_not_permitted_to_cardholder", "transaction_not_allowed_at_terminal", "transaction_not_supported_or_blocked_by_issuer", "suspected_fraud", "activity_amount_limit_exceeded", "restricted_card", "security_violation", "transaction_does_not_fulfill_anti_money_laundering_requirement", "blocked_by_cardholder", "blocked_first_use", "credit_issuer_unavailable", "negative_card_verification_value_results", "issuer_unavailable", "financial_institution_cannot_be_found", "transaction_cannot_be_completed", "duplicate_transaction", "system_malfunction", "additional_customer_authentication_required", "surcharge_amount_not_permitted", "decline_for_cvv2_failure", "stop_payment_order", "revocation_of_authorization_order", "revocation_of_all_authorizations_order", "unable_to_locate_record", "file_is_temporarily_unavailable", "incorrect_pin", "allowable_number_of_pin_entry_tries_exceeded", "unable_to_locate_previous_message", "pin_error_found", "cannot_verify_pin", "verification_data_failed", "surcharge_amount_not_supported_by_debit_network_issuer", "cash_service_not_available", "cashback_request_exceeds_issuer_limit", "transaction_amount_exceeds_pre_authorized_approval_amount", "transaction_does_not_qualify_for_visa_pin", "offline_declined", "unable_to_go_online", "valid_account_but_amount_not_supported", "invalid_use_of_merchant_category_code_correct_and_reattempt", "card_authentication_failed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card issuer has declined the transaction without providing a specific reason.", "The number of transactions for the card has exceeded the limit set by the issuer.", "The card issuer requires the cardholder to contact them for further information regarding the transaction.", "The card issuer requires the cardholder to contact them due to a special condition related to the transaction.", "The merchant is not valid for this transaction.", "The card should be retained by the terminal.", "An error occurred during processing of the transaction.", "The card should be retained by the terminal due to a special condition.", "The transaction is invalid and cannot be processed.", "The amount of the transaction is invalid.", "The account number provided is invalid.", "The issuer of the card could not be found.", "The transaction should be re-entered for processing.", "There is no credit account associated with the card.", "The card should be retained by the terminal because it has been reported lost.", "The card should be retained by the terminal because it has been reported stolen.", "The account associated with the card has been closed.", "There are insufficient funds in the account to complete the transaction.", "There is no checking account associated with the card.", "There is no savings account associated with the card.", "The card has expired and cannot be used for transactions.", "The transaction is not permitted for this cardholder.", "The transaction is not allowed at this terminal.", "The transaction is not supported or has been blocked by the issuer.", "The transaction has been flagged as suspected fraud and cannot be processed.", "The amount of activity on the card has exceeded the limit set by the issuer.", "The card has restrictions that prevent it from being used for this transaction.", "A security violation has occurred, preventing the transaction from being processed.", "The transaction does not meet the anti-money laundering requirements set by the issuer.", "The transaction was blocked by the cardholder.", "The first use of the card has been blocked by the issuer.", "The credit issuer is currently unavailable to process the transaction.", "The card verification value (CVV) results were negative, indicating a potential issue with the card.", "The issuer of the card is currently unavailable to process the transaction.", "The financial institution associated with the card could not be found.", "The transaction cannot be completed due to an unspecified reason.", "The transaction is a duplicate of a previous transaction and cannot be processed again.", "A system malfunction occurred, preventing the transaction from being processed.", "Additional customer authentication is required to complete the transaction.", "The surcharge amount applied to the transaction is not permitted by the issuer.", "The transaction was declined due to a failure in verifying the CVV2 code.", "A stop payment order has been placed on this transaction.", "An order has been placed to revoke authorization for this transaction.", "An order has been placed to revoke all authorizations for this cardholder.", "The record associated with the transaction could not be located.", "The file needed for the transaction is temporarily unavailable.", "The PIN entered for the transaction is incorrect.", "The allowable number of PIN entry tries has been exceeded.", "The previous message associated with the transaction could not be located.", "An error was found with the PIN associated with the transaction.", "The PIN associated with the transaction could not be verified.", "The verification data associated with the transaction has failed.", "The surcharge amount is not supported by the debit network issuer.", "Cash service is not available for this transaction.", "The cashback request exceeds the issuer limit.", "The transaction amount exceeds the pre-authorized approval amount.", "The transaction does not qualify for Visa PIN processing.", "The transaction was declined offline.", "The terminal was unable to go online to process the transaction.", "The account is valid but the transaction amount is not supported.", "The merchant category code was used incorrectly; correct it and reattempt the transaction.", "The card authentication process has failed." ] } }, "required": [ "declined_at", "reason", "network_transaction_identifier" ], "title": "Card Push Transfer Card Push Transfer Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Push Transfer Declines", "nullable": true }, "id": { "description": "The Card Push Transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Push Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_category_code": { "description": "The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it.", "type": "string", "x-documentation-priority": "default" }, "merchant_city_name": { "description": "The city name of the merchant (generally your business) sending the transfer.", "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.", "type": "string", "x-documentation-priority": "default" }, "merchant_name_prefix": { "description": "For certain Business Application Identifiers, the statement descriptor is `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to four character prefix that identifies the merchant.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The postal code of the merchant (generally your business) sending the transfer.", "type": "string", "x-documentation-priority": "default" }, "merchant_state": { "description": "The state of the merchant (generally your business) sending the transfer.", "type": "string", "x-documentation-priority": "default" }, "presentment_amount": { "additionalProperties": false, "description": "The amount that was transferred. The receiving bank will have converted this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account.", "example": { "currency": "USD", "value": "12.34" }, "properties": { "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.", "enum": [ "AFN", "EUR", "ALL", "DZD", "USD", "AOA", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "INR", "BTN", "BOB", "BOV", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "CAD", "KYD", "CLP", "CLF", "CNY", "COP", "COU", "KMF", "CDF", "NZD", "CRC", "CUP", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "SZL", "ETB", "FKP", "FJD", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "MXN", "MXV", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLE", "SGD", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SEK", "CHE", "CHW", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "USN", "UYU", "UYI", "UYW", "UZS", "VUV", "VES", "VED", "VND", "YER", "ZMW", "ZWG" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "AFN", "EUR", "ALL", "DZD", "USD", "AOA", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "INR", "BTN", "BOB", "BOV", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "CAD", "KYD", "CLP", "CLF", "CNY", "COP", "COU", "KMF", "CDF", "NZD", "CRC", "CUP", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "SZL", "ETB", "FKP", "FJD", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "MXN", "MXV", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLE", "SGD", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SEK", "CHE", "CHW", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "USN", "UYU", "UYI", "UYW", "UZS", "VUV", "VES", "VED", "VND", "YER", "ZMW", "ZWG" ] }, "value": { "description": "The amount value represented as a string containing a decimal number in major units (so e.g., \"12.34\" for $12.34).", "type": "string", "x-documentation-priority": "default" } }, "required": [ "value", "currency" ], "title": "Card Push Transfer Amount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Amounts" }, "recipient_name": { "description": "The name of the funds recipient.", "type": "string", "x-documentation-priority": "default" }, "route": { "description": "The card network route used for the transfer.", "enum": [ "visa", "mastercard", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa and Interlink", "Mastercard and Maestro", "Pulse" ] }, "sender_address_city": { "description": "The city of the sender.", "type": "string", "x-documentation-priority": "default" }, "sender_address_line1": { "description": "The address line 1 of the sender.", "type": "string", "x-documentation-priority": "default" }, "sender_address_postal_code": { "description": "The postal code of the sender.", "type": "string", "x-documentation-priority": "default" }, "sender_address_state": { "description": "The state of the sender.", "type": "string", "x-documentation-priority": "default" }, "sender_name": { "description": "The name of the funds originator.", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The Account Number the recipient will see as having sent the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "canceled", "pending_reviewing", "requires_attention", "pending_submission", "submitted", "complete", "declined" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is queued to be submitted to the card network.", "The transfer has been submitted and is pending a response from the card network.", "The transfer has been sent successfully and is complete.", "The transfer was declined by the network or the recipient's bank." ] }, "submission": { "additionalProperties": false, "description": "After the transfer is submitted to the card network, this will contain supplemental details.", "example": { "retrieval_reference_number": "123456789012", "sender_reference": "OPQRRX3BNAKA6QLT", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "123456" }, "properties": { "retrieval_reference_number": { "description": "A 12-digit retrieval reference number that identifies the transfer. Usually a combination of a timestamp and the trace number.", "type": "string", "x-documentation-priority": "default" }, "sender_reference": { "description": "A unique reference for the transfer.", "type": "string", "x-documentation-priority": "default" }, "submitted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to the card network.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "trace_number": { "description": "A 6-digit trace number that identifies the transfer within a small window of time.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "submitted_at", "trace_number", "retrieval_reference_number", "sender_reference" ], "title": "Card Push Transfer Card Push Transfer Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Push Transfer Submissions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_push_transfer`.", "enum": [ "card_push_transfer" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "card_token_id", "created_at", "created_by", "approval", "cancellation", "account_id", "source_account_number_id", "status", "presentment_amount", "merchant_city_name", "merchant_state", "merchant_postal_code", "merchant_category_code", "merchant_name", "merchant_name_prefix", "sender_name", "sender_address_line1", "sender_address_city", "sender_address_state", "sender_address_postal_code", "recipient_name", "business_application_identifier", "route", "submission", "decline", "acceptance", "idempotency_key" ], "title": "Card Push Transfer", "type": "object", "x-event-categories": [ "card_push_transfer.created", "card_push_transfer.updated" ], "x-tag": "Card Push Transfers", "x-title-plural": "Card Push Transfers" }, "card_push_transfer_list": { "additionalProperties": true, "description": "A list of Card Push Transfer objects.", "example": { "data": [ { "acceptance": null, "account_id": "account_in71c4amph0vgo2qllky", "approval": null, "business_application_identifier": "funds_disbursement", "cancellation": null, "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "decline": null, "id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye", "idempotency_key": null, "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_name_prefix": "Acme", "merchant_postal_code": "10045", "merchant_state": "NY", "presentment_amount": { "currency": "USD", "value": "12.34" }, "recipient_name": "Ian Crease", "route": "visa", "sender_address_city": "New York", "sender_address_line1": "33 Liberty Street", "sender_address_postal_code": "10045", "sender_address_state": "NY", "sender_name": "Ian Crease", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "pending_submission", "submission": null, "type": "card_push_transfer" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card_push_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card Push Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Push Transfer Lists" }, "card_refund": { "additionalProperties": true, "description": "Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction.", "example": { "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_refund_imgc2xwplh6t4r3gn16e", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "authorization_identification_response": "ABC123", "transaction_id": "627199945183184" }, "presentment_amount": 100, "presentment_currency": "USD", "purchase_details": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_refund" }, "properties": { "amount": { "description": "The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "cashback": { "additionalProperties": false, "description": "Cashback debited for this transaction, if eligible. Cashback is paid out in aggregate, monthly.", "example": { "amount": "0.137465", "currency": "USD" }, "properties": { "amount": { "description": "The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] } }, "required": [ "amount", "currency" ], "title": "Card Refund Cashback", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cashbacks", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "id": { "description": "The Card Refund identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Refunds" }, "interchange": { "additionalProperties": false, "description": "Interchange assessed as a part of this transaction.", "example": { "amount": "0.137465", "code": "271", "currency": "USD" }, "properties": { "amount": { "description": "The interchange amount given as a string containing a decimal number in major units (so e.g., \"3.14\" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "code": { "description": "The card network specific interchange code.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] } }, "required": [ "amount", "currency", "code" ], "title": "Card Refund Card Interchange", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Interchanges", "nullable": true }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The 4-digit MCC describing the merchant's business.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The name of the merchant.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is always a 5-digit ZIP code.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for this refund.", "properties": { "acquirer_business_id": { "description": "A network assigned business ID that identifies the acquirer that processed this transaction.", "type": "string", "x-documentation-priority": "default" }, "acquirer_reference_number": { "description": "A globally unique identifier for this settlement.", "type": "string", "x-documentation-priority": "default" }, "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "acquirer_reference_number", "acquirer_business_id", "authorization_identification_response" ], "title": "Card Refund NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "NetworkIdentifiers" }, "presentment_amount": { "description": "The amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "purchase_details": { "additionalProperties": false, "description": "Additional details about the card purchase, such as tax and industry-specific fields.", "example": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "properties": { "car_rental": { "additionalProperties": false, "description": "Fields specific to car rentals.", "properties": { "car_class_code": { "description": "Code indicating the vehicle's class.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "checkout_date": { "description": "Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "daily_rental_rate_amount": { "description": "Daily rate being charged for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "daily_rental_rate_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "days_rented": { "description": "Number of days the vehicle was rented.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "extra_charges": { "description": "Additional charges (gas, late fee, etc.) being billed.", "enum": [ "no_extra_charge", "gas", "extra_mileage", "late_return", "one_way_service_fee", "parking_violation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No extra charge", "Gas", "Extra mileage", "Late return", "One way service fee", "Parking violation" ], "nullable": true }, "fuel_charges_amount": { "description": "Fuel charges for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "fuel_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "insurance_charges_amount": { "description": "Any insurance being charged for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "insurance_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "no_show_indicator": { "description": "An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a \"no-show\" charge).", "enum": [ "not_applicable", "no_show_for_specialized_vehicle" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not applicable", "No show for specialized vehicle" ], "nullable": true }, "one_way_drop_off_charges_amount": { "description": "Charges for returning the vehicle at a different location than where it was picked up.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "one_way_drop_off_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "renter_name": { "description": "Name of the person renting the vehicle.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "weekly_rental_rate_amount": { "description": "Weekly rate being charged for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "weekly_rental_rate_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "extra_charges", "days_rented", "no_show_indicator", "checkout_date", "daily_rental_rate_amount", "daily_rental_rate_currency", "weekly_rental_rate_amount", "weekly_rental_rate_currency", "insurance_charges_amount", "insurance_charges_currency", "fuel_charges_amount", "fuel_charges_currency", "one_way_drop_off_charges_amount", "one_way_drop_off_charges_currency", "car_class_code", "renter_name" ], "title": "Card Refund Card Purchase Details CarRental", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CarRentals", "nullable": true }, "customer_reference_identifier": { "description": "An identifier from the merchant for the customer or consumer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "local_tax_amount": { "description": "The state or provincial tax amount in minor units.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "local_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "lodging": { "additionalProperties": false, "description": "Fields specific to lodging.", "properties": { "check_in_date": { "description": "Date the customer checked in.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "daily_room_rate_amount": { "description": "Daily rate being charged for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "daily_room_rate_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "extra_charges": { "description": "Additional charges (phone, late check-out, etc.) being billed.", "enum": [ "no_extra_charge", "restaurant", "gift_shop", "mini_bar", "telephone", "other", "laundry" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No extra charge", "Restaurant", "Gift shop", "Mini bar", "Telephone", "Other", "Laundry" ], "nullable": true }, "folio_cash_advances_amount": { "description": "Folio cash advances for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "folio_cash_advances_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "food_beverage_charges_amount": { "description": "Food and beverage charges for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "food_beverage_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "no_show_indicator": { "description": "Indicator that the cardholder is being billed for a reserved room that was not actually used.", "enum": [ "not_applicable", "no_show" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not applicable", "No show" ], "nullable": true }, "prepaid_expenses_amount": { "description": "Prepaid expenses being charged for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "prepaid_expenses_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "room_nights": { "description": "Number of nights the room was rented.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_room_tax_amount": { "description": "Total room tax being charged.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_room_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "total_tax_amount": { "description": "Total tax being charged for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "no_show_indicator", "extra_charges", "check_in_date", "daily_room_rate_amount", "daily_room_rate_currency", "total_tax_amount", "total_tax_currency", "prepaid_expenses_amount", "prepaid_expenses_currency", "food_beverage_charges_amount", "food_beverage_charges_currency", "folio_cash_advances_amount", "folio_cash_advances_currency", "room_nights", "total_room_tax_amount", "total_room_tax_currency" ], "title": "Card Refund Card Purchase Details Lodging", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Lodgings", "nullable": true }, "national_tax_amount": { "description": "The national tax amount in minor units.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "national_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "purchase_identifier": { "description": "An identifier from the merchant for the purchase to the issuer and cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "purchase_identifier_format": { "description": "The format of the purchase identifier.", "enum": [ "free_text", "order_number", "rental_agreement_number", "hotel_folio_number", "invoice_number" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Free text", "Order number", "Rental agreement number", "Hotel folio number", "Invoice number" ], "nullable": true }, "travel": { "additionalProperties": false, "description": "Fields specific to travel.", "properties": { "ancillary": { "additionalProperties": false, "description": "Ancillary purchases in addition to the airfare.", "properties": { "connected_ticket_document_number": { "description": "If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "credit_reason_indicator": { "description": "Indicates the reason for a credit to the cardholder.", "enum": [ "no_credit", "passenger_transport_ancillary_purchase_cancellation", "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No credit", "Passenger transport ancillary purchase cancellation", "Airline ticket and passenger transport ancillary purchase cancellation", "Other" ], "nullable": true }, "passenger_name_or_description": { "description": "Name of the passenger or description of the ancillary purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "services": { "description": "Additional travel charges, such as baggage fees.", "items": { "additionalProperties": false, "properties": { "category": { "description": "Category of the ancillary service.", "enum": [ "none", "bundled_service", "baggage_fee", "change_fee", "cargo", "carbon_offset", "frequent_flyer", "gift_card", "ground_transport", "in_flight_entertainment", "lounge", "medical", "meal_beverage", "other", "passenger_assist_fee", "pets", "seat_fees", "standby", "service_fee", "store", "travel_service", "unaccompanied_travel", "upgrades", "wifi" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "None", "Bundled service", "Baggage fee", "Change fee", "Cargo", "Carbon offset", "Frequent flyer", "Gift card", "Ground transport", "In-flight entertainment", "Lounge", "Medical", "Meal beverage", "Other", "Passenger assist fee", "Pets", "Seat fees", "Standby", "Service fee", "Store", "Travel service", "Unaccompanied travel", "Upgrades", "Wi-fi" ], "nullable": true }, "sub_category": { "description": "Sub-category of the ancillary service, free-form.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "category", "sub_category" ], "title": "Card Refund Card Purchase Details Travel Ancillary ServicesElement", "type": "object", "x-event-categories": [], "x-title-plural": "ServicesElements" }, "type": "array", "x-documentation-priority": "default" }, "ticket_document_number": { "description": "Ticket document number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "ticket_document_number", "passenger_name_or_description", "connected_ticket_document_number", "credit_reason_indicator", "services" ], "title": "Card Refund Card Purchase Details Travel Ancillary", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Ancillaries", "nullable": true }, "computerized_reservation_system": { "description": "Indicates the computerized reservation system used to book the ticket.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "credit_reason_indicator": { "description": "Indicates the reason for a credit to the cardholder.", "enum": [ "no_credit", "passenger_transport_ancillary_purchase_cancellation", "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation", "airline_ticket_cancellation", "other", "partial_refund_of_airline_ticket" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No credit", "Passenger transport ancillary purchase cancellation", "Airline ticket and passenger transport ancillary purchase cancellation", "Airline ticket cancellation", "Other", "Partial refund of airline ticket" ], "nullable": true }, "departure_date": { "description": "Date of departure.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "origination_city_airport_code": { "description": "Code for the originating city or airport.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "passenger_name": { "description": "Name of the passenger.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "restricted_ticket_indicator": { "description": "Indicates whether this ticket is non-refundable.", "enum": [ "no_restrictions", "restricted_non_refundable_ticket" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No restrictions", "Restricted non-refundable ticket" ], "nullable": true }, "ticket_change_indicator": { "description": "Indicates why a ticket was changed.", "enum": [ "none", "change_to_existing_ticket", "new_ticket" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "None", "Change to existing ticket", "New ticket" ], "nullable": true }, "ticket_number": { "description": "Ticket number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "travel_agency_code": { "description": "Code for the travel agency if the ticket was issued by a travel agency.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "travel_agency_name": { "description": "Name of the travel agency if the ticket was issued by a travel agency.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trip_legs": { "description": "Fields specific to each leg of the journey.", "items": { "additionalProperties": false, "properties": { "carrier_code": { "description": "Carrier code (e.g., United Airlines, Jet Blue, etc.).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "destination_city_airport_code": { "description": "Code for the destination city or airport.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "fare_basis_code": { "description": "Fare basis code.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "flight_number": { "description": "Flight number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "service_class": { "description": "Service class (e.g., first class, business class, etc.).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "stop_over_code": { "description": "Indicates whether a stopover is allowed on this ticket.", "enum": [ "none", "stop_over_allowed", "stop_over_not_allowed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "None", "Stop over allowed", "Stop over not allowed" ], "nullable": true } }, "required": [ "flight_number", "carrier_code", "fare_basis_code", "service_class", "stop_over_code", "destination_city_airport_code" ], "title": "Card Refund Card Purchase Details Travel TripLegsElement", "type": "object", "x-event-categories": [], "x-title-plural": "TripLegsElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true } }, "required": [ "ticket_number", "passenger_name", "departure_date", "origination_city_airport_code", "travel_agency_code", "travel_agency_name", "restricted_ticket_indicator", "computerized_reservation_system", "credit_reason_indicator", "ticket_change_indicator", "trip_legs", "ancillary" ], "title": "Card Refund Card Purchase Details Travel", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Travels", "nullable": true } }, "required": [ "purchase_identifier", "purchase_identifier_format", "customer_reference_identifier", "local_tax_amount", "local_tax_currency", "national_tax_amount", "national_tax_currency", "car_rental", "lodging", "travel" ], "title": "Card Refund Card Purchase Details", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Purchase Details", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card refund.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Refund Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the Transaction associated with this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_refund`.", "enum": [ "card_refund" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "card_payment_id", "amount", "currency", "presentment_amount", "presentment_currency", "merchant_acceptor_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "merchant_name", "merchant_category_code", "interchange", "cashback", "purchase_details", "scheme_fees", "transaction_id", "network_identifiers" ], "title": "Card Refund", "type": "object", "x-event-categories": [], "x-title-plural": "Card Refunds" }, "card_reversal": { "additionalProperties": true, "description": "Card Reversals cancel parts of or the entirety of an existing Card Authorization.", "example": { "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_reversal_8vr9qy60cgf5d0slpb68", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "presentment_currency": "USD", "reversal_amount": 20, "reversal_presentment_amount": 20, "reversal_reason": "reversed_by_customer", "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_reversal", "updated_authorization_amount": 80, "updated_authorization_presentment_amount": 80 }, "properties": { "card_authorization_id": { "description": "The identifier for the Card Authorization this reverses.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "id": { "description": "The Card Reversal identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Reversals" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network": { "description": "The card network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Card Reversal NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction associated with this Card Reversal.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "reversal_amount": { "description": "The amount of this reversal in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "reversal_presentment_amount": { "description": "The amount of this reversal in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "reversal_reason": { "description": "Why this reversal was initiated.", "enum": [ "reversed_by_customer", "reversed_by_network_or_acquirer", "reversed_by_point_of_sale", "partial_reversal" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Card Reversal was initiated at the customer's request.", "The Card Reversal was initiated by the network or acquirer.", "The Card Reversal was initiated by the point of sale device.", "The Card Reversal was a partial reversal, for any reason." ], "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card reversal.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Reversal Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_reversal`.", "enum": [ "card_reversal" ], "type": "string", "x-documentation-priority": "default" }, "updated_authorization_amount": { "description": "The amount left pending on the Card Authorization in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "updated_authorization_presentment_amount": { "description": "The amount left pending on the Card Authorization in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "type", "id", "reversal_amount", "reversal_presentment_amount", "updated_authorization_amount", "updated_authorization_presentment_amount", "currency", "presentment_currency", "card_authorization_id", "network", "pending_transaction_id", "network_identifiers", "reversal_reason", "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "terminal_id", "scheme_fees" ], "title": "Card Reversal", "type": "object", "x-event-categories": [], "x-title-plural": "Card Reversals" }, "card_settlement": { "additionalProperties": true, "description": "Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it.", "example": { "amount": 100, "card_authorization": null, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_settlement_khv5kfeu0vndj291omg6", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "authorization_identification_response": "ABC123", "transaction_id": "627199945183184" }, "pending_transaction_id": null, "presentment_amount": 100, "presentment_currency": "USD", "purchase_details": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "surcharge": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_settlement" }, "properties": { "amount": { "description": "The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_authorization": { "description": "The Card Authorization that was created prior to this Card Settlement, if one exists.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "cashback": { "additionalProperties": false, "description": "Cashback earned on this transaction, if eligible. Cashback is paid out in aggregate, monthly.", "example": { "amount": "0.137465", "currency": "USD" }, "properties": { "amount": { "description": "The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] } }, "required": [ "amount", "currency" ], "title": "Card Settlement Cashback", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cashbacks", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "id": { "description": "The Card Settlement identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Settlements" }, "interchange": { "additionalProperties": false, "description": "Interchange assessed as a part of this transaction.", "example": { "amount": "0.137465", "code": "271", "currency": "USD" }, "properties": { "amount": { "description": "The interchange amount given as a string containing a decimal number in major units (so e.g., \"3.14\" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "code": { "description": "The card network specific interchange code.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] } }, "required": [ "amount", "currency", "code" ], "title": "Card Settlement Card Interchange", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Interchanges", "nullable": true }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The 4-digit MCC describing the merchant's business.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The name of the merchant.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is always a 5-digit ZIP code.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network": { "description": "The card network on which this transaction was processed.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for this refund.", "properties": { "acquirer_business_id": { "description": "A network assigned business ID that identifies the acquirer that processed this transaction.", "type": "string", "x-documentation-priority": "default" }, "acquirer_reference_number": { "description": "A globally unique identifier for this settlement.", "type": "string", "x-documentation-priority": "default" }, "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "acquirer_reference_number", "acquirer_business_id", "authorization_identification_response" ], "title": "Card Settlement NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "NetworkIdentifiers" }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction associated with this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "presentment_amount": { "description": "The amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "purchase_details": { "additionalProperties": false, "description": "Additional details about the card purchase, such as tax and industry-specific fields.", "example": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "properties": { "car_rental": { "additionalProperties": false, "description": "Fields specific to car rentals.", "properties": { "car_class_code": { "description": "Code indicating the vehicle's class.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "checkout_date": { "description": "Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "daily_rental_rate_amount": { "description": "Daily rate being charged for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "daily_rental_rate_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "days_rented": { "description": "Number of days the vehicle was rented.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "extra_charges": { "description": "Additional charges (gas, late fee, etc.) being billed.", "enum": [ "no_extra_charge", "gas", "extra_mileage", "late_return", "one_way_service_fee", "parking_violation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No extra charge", "Gas", "Extra mileage", "Late return", "One way service fee", "Parking violation" ], "nullable": true }, "fuel_charges_amount": { "description": "Fuel charges for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "fuel_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "insurance_charges_amount": { "description": "Any insurance being charged for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "insurance_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "no_show_indicator": { "description": "An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a \"no-show\" charge).", "enum": [ "not_applicable", "no_show_for_specialized_vehicle" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not applicable", "No show for specialized vehicle" ], "nullable": true }, "one_way_drop_off_charges_amount": { "description": "Charges for returning the vehicle at a different location than where it was picked up.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "one_way_drop_off_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "renter_name": { "description": "Name of the person renting the vehicle.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "weekly_rental_rate_amount": { "description": "Weekly rate being charged for the vehicle.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "weekly_rental_rate_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "extra_charges", "days_rented", "no_show_indicator", "checkout_date", "daily_rental_rate_amount", "daily_rental_rate_currency", "weekly_rental_rate_amount", "weekly_rental_rate_currency", "insurance_charges_amount", "insurance_charges_currency", "fuel_charges_amount", "fuel_charges_currency", "one_way_drop_off_charges_amount", "one_way_drop_off_charges_currency", "car_class_code", "renter_name" ], "title": "Card Settlement Card Purchase Details CarRental", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CarRentals", "nullable": true }, "customer_reference_identifier": { "description": "An identifier from the merchant for the customer or consumer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "local_tax_amount": { "description": "The state or provincial tax amount in minor units.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "local_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "lodging": { "additionalProperties": false, "description": "Fields specific to lodging.", "properties": { "check_in_date": { "description": "Date the customer checked in.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "daily_room_rate_amount": { "description": "Daily rate being charged for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "daily_room_rate_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "extra_charges": { "description": "Additional charges (phone, late check-out, etc.) being billed.", "enum": [ "no_extra_charge", "restaurant", "gift_shop", "mini_bar", "telephone", "other", "laundry" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No extra charge", "Restaurant", "Gift shop", "Mini bar", "Telephone", "Other", "Laundry" ], "nullable": true }, "folio_cash_advances_amount": { "description": "Folio cash advances for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "folio_cash_advances_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "food_beverage_charges_amount": { "description": "Food and beverage charges for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "food_beverage_charges_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "no_show_indicator": { "description": "Indicator that the cardholder is being billed for a reserved room that was not actually used.", "enum": [ "not_applicable", "no_show" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not applicable", "No show" ], "nullable": true }, "prepaid_expenses_amount": { "description": "Prepaid expenses being charged for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "prepaid_expenses_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "room_nights": { "description": "Number of nights the room was rented.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_room_tax_amount": { "description": "Total room tax being charged.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_room_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "total_tax_amount": { "description": "Total tax being charged for the room.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "total_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "no_show_indicator", "extra_charges", "check_in_date", "daily_room_rate_amount", "daily_room_rate_currency", "total_tax_amount", "total_tax_currency", "prepaid_expenses_amount", "prepaid_expenses_currency", "food_beverage_charges_amount", "food_beverage_charges_currency", "folio_cash_advances_amount", "folio_cash_advances_currency", "room_nights", "total_room_tax_amount", "total_room_tax_currency" ], "title": "Card Settlement Card Purchase Details Lodging", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Lodgings", "nullable": true }, "national_tax_amount": { "description": "The national tax amount in minor units.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "national_tax_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "purchase_identifier": { "description": "An identifier from the merchant for the purchase to the issuer and cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "purchase_identifier_format": { "description": "The format of the purchase identifier.", "enum": [ "free_text", "order_number", "rental_agreement_number", "hotel_folio_number", "invoice_number" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Free text", "Order number", "Rental agreement number", "Hotel folio number", "Invoice number" ], "nullable": true }, "travel": { "additionalProperties": false, "description": "Fields specific to travel.", "properties": { "ancillary": { "additionalProperties": false, "description": "Ancillary purchases in addition to the airfare.", "properties": { "connected_ticket_document_number": { "description": "If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "credit_reason_indicator": { "description": "Indicates the reason for a credit to the cardholder.", "enum": [ "no_credit", "passenger_transport_ancillary_purchase_cancellation", "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No credit", "Passenger transport ancillary purchase cancellation", "Airline ticket and passenger transport ancillary purchase cancellation", "Other" ], "nullable": true }, "passenger_name_or_description": { "description": "Name of the passenger or description of the ancillary purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "services": { "description": "Additional travel charges, such as baggage fees.", "items": { "additionalProperties": false, "properties": { "category": { "description": "Category of the ancillary service.", "enum": [ "none", "bundled_service", "baggage_fee", "change_fee", "cargo", "carbon_offset", "frequent_flyer", "gift_card", "ground_transport", "in_flight_entertainment", "lounge", "medical", "meal_beverage", "other", "passenger_assist_fee", "pets", "seat_fees", "standby", "service_fee", "store", "travel_service", "unaccompanied_travel", "upgrades", "wifi" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "None", "Bundled service", "Baggage fee", "Change fee", "Cargo", "Carbon offset", "Frequent flyer", "Gift card", "Ground transport", "In-flight entertainment", "Lounge", "Medical", "Meal beverage", "Other", "Passenger assist fee", "Pets", "Seat fees", "Standby", "Service fee", "Store", "Travel service", "Unaccompanied travel", "Upgrades", "Wi-fi" ], "nullable": true }, "sub_category": { "description": "Sub-category of the ancillary service, free-form.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "category", "sub_category" ], "title": "Card Settlement Card Purchase Details Travel Ancillary ServicesElement", "type": "object", "x-event-categories": [], "x-title-plural": "ServicesElements" }, "type": "array", "x-documentation-priority": "default" }, "ticket_document_number": { "description": "Ticket document number.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "ticket_document_number", "passenger_name_or_description", "connected_ticket_document_number", "credit_reason_indicator", "services" ], "title": "Card Settlement Card Purchase Details Travel Ancillary", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Ancillaries", "nullable": true }, "computerized_reservation_system": { "description": "Indicates the computerized reservation system used to book the ticket.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "credit_reason_indicator": { "description": "Indicates the reason for a credit to the cardholder.", "enum": [ "no_credit", "passenger_transport_ancillary_purchase_cancellation", "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation", "airline_ticket_cancellation", "other", "partial_refund_of_airline_ticket" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No credit", "Passenger transport ancillary purchase cancellation", "Airline ticket and passenger transport ancillary purchase cancellation", "Airline ticket cancellation", "Other", "Partial refund of airline ticket" ], "nullable": true }, "departure_date": { "description": "Date of departure.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "origination_city_airport_code": { "description": "Code for the originating city or airport.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "passenger_name": { "description": "Name of the passenger.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "restricted_ticket_indicator": { "description": "Indicates whether this ticket is non-refundable.", "enum": [ "no_restrictions", "restricted_non_refundable_ticket" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No restrictions", "Restricted non-refundable ticket" ], "nullable": true }, "ticket_change_indicator": { "description": "Indicates why a ticket was changed.", "enum": [ "none", "change_to_existing_ticket", "new_ticket" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "None", "Change to existing ticket", "New ticket" ], "nullable": true }, "ticket_number": { "description": "Ticket number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "travel_agency_code": { "description": "Code for the travel agency if the ticket was issued by a travel agency.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "travel_agency_name": { "description": "Name of the travel agency if the ticket was issued by a travel agency.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trip_legs": { "description": "Fields specific to each leg of the journey.", "items": { "additionalProperties": false, "properties": { "carrier_code": { "description": "Carrier code (e.g., United Airlines, Jet Blue, etc.).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "destination_city_airport_code": { "description": "Code for the destination city or airport.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "fare_basis_code": { "description": "Fare basis code.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "flight_number": { "description": "Flight number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "service_class": { "description": "Service class (e.g., first class, business class, etc.).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "stop_over_code": { "description": "Indicates whether a stopover is allowed on this ticket.", "enum": [ "none", "stop_over_allowed", "stop_over_not_allowed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "None", "Stop over allowed", "Stop over not allowed" ], "nullable": true } }, "required": [ "flight_number", "carrier_code", "fare_basis_code", "service_class", "stop_over_code", "destination_city_airport_code" ], "title": "Card Settlement Card Purchase Details Travel TripLegsElement", "type": "object", "x-event-categories": [], "x-title-plural": "TripLegsElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true } }, "required": [ "ticket_number", "passenger_name", "departure_date", "origination_city_airport_code", "travel_agency_code", "travel_agency_name", "restricted_ticket_indicator", "computerized_reservation_system", "credit_reason_indicator", "ticket_change_indicator", "trip_legs", "ancillary" ], "title": "Card Settlement Card Purchase Details Travel", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Travels", "nullable": true } }, "required": [ "purchase_identifier", "purchase_identifier_format", "customer_reference_identifier", "local_tax_amount", "local_tax_currency", "national_tax_amount", "national_tax_currency", "car_rental", "lodging", "travel" ], "title": "Card Settlement Card Purchase Details", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Purchase Details", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card settlement.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Card Settlement Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "surcharge": { "additionalProperties": false, "description": "Surcharge amount details, if applicable. The amount is positive if the surcharge is added to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount).", "properties": { "amount": { "description": "The surcharge amount in the minor unit of the transaction's settlement currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_amount": { "description": "The surcharge amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "amount", "presentment_amount" ], "title": "Card Settlement Surcharge", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Surcharges", "nullable": true }, "transaction_id": { "description": "The identifier of the Transaction associated with this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_settlement`.", "enum": [ "card_settlement" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "card_payment_id", "card_authorization", "amount", "currency", "presentment_amount", "presentment_currency", "merchant_acceptor_id", "merchant_city", "merchant_state", "merchant_country", "merchant_name", "merchant_postal_code", "merchant_category_code", "transaction_id", "pending_transaction_id", "interchange", "cashback", "purchase_details", "surcharge", "scheme_fees", "network", "network_identifiers" ], "title": "Card Settlement", "type": "object", "x-event-categories": [], "x-title-plural": "Card Settlements" }, "card_token": { "additionalProperties": false, "description": "Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.", "example": { "created_at": "2020-01-31T23:59:59Z", "expiration_date": "2020-01-31", "id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "last4": "1234", "length": 16, "prefix": "46637100", "type": "card_token" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card token was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card expires.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Card Token's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" }, "last4": { "description": "The last 4 digits of the card number.", "type": "string", "x-documentation-priority": "default" }, "length": { "description": "The length of the card number.", "type": "integer", "x-documentation-priority": "default" }, "prefix": { "description": "The prefix of the card number, usually 8 digits.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_token`.", "enum": [ "card_token" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "prefix", "last4", "length", "expiration_date" ], "title": "Card Token", "type": "object", "x-event-categories": [], "x-tag": "Card Tokens", "x-title-plural": "Card Tokens" }, "card_token_capabilities": { "additionalProperties": false, "description": "The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank's configuration of the card range.", "example": { "routes": [ { "cross_border_push_transfers": "not_supported", "domestic_push_transfers": "supported", "issuer_country": "US", "route": "visa" } ], "type": "card_token_capabilities" }, "properties": { "routes": { "description": "Each route represent a path e.g., a push transfer can take.", "items": { "additionalProperties": false, "properties": { "cross_border_push_transfers": { "description": "Whether you can push funds to the card using cross-border Card Push Transfers.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The capability is supported.", "The capability is not supported." ] }, "domestic_push_transfers": { "description": "Whether you can push funds to the card using domestic Card Push Transfers.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The capability is supported.", "The capability is not supported." ] }, "issuer_country": { "description": "The ISO-3166-1 alpha-2 country code of the card's issuing bank.", "type": "string", "x-documentation-priority": "default" }, "route": { "description": "The card network route the capabilities apply to.", "enum": [ "visa", "mastercard", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa and Interlink", "Mastercard and Maestro", "Pulse" ] } }, "required": [ "route", "issuer_country", "domestic_push_transfers", "cross_border_push_transfers" ], "title": "Card Token Capabilities RoutesElement", "type": "object", "x-event-categories": [], "x-title-plural": "RoutesElements" }, "type": "array", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_token_capabilities`.", "enum": [ "card_token_capabilities" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "routes" ], "title": "Card Token Capabilities", "type": "object", "x-event-categories": [], "x-title-plural": "Card Token Capabilities" }, "card_token_list": { "additionalProperties": true, "description": "A list of Card Token objects.", "example": { "data": [ { "created_at": "2020-01-31T23:59:59Z", "expiration_date": "2020-01-31", "id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "last4": "1234", "length": 16, "prefix": "46637100", "type": "card_token" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card_token" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card Token List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Token Lists" }, "card_validation": { "additionalProperties": true, "description": "Card Validations are used to validate a card and its cardholder before sending funds to or pulling funds from a card.", "example": { "acceptance": { "accepted_at": "2020-01-31T23:59:59Z", "authorization_identification_response": "ABCDEF", "card_verification_value2_result": null, "cardholder_first_name_result": null, "cardholder_full_name_result": null, "cardholder_last_name_result": null, "cardholder_middle_name_result": null, "cardholder_postal_code_result": null, "cardholder_street_address_result": null, "network_transaction_identifier": "841488484271872" }, "account_id": "account_in71c4amph0vgo2qllky", "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "cardholder_first_name": "Dee", "cardholder_last_name": "Hock", "cardholder_middle_name": "Ward", "cardholder_postal_code": "10045", "cardholder_street_address": "33 Liberty Street", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "decline": { "declined_at": "2020-01-31T23:59:59Z", "network_transaction_identifier": "841488484271872", "reason": "transaction_not_permitted_to_cardholder" }, "id": "outbound_card_validation_qqlzagpc6v1x2gcdhe24", "idempotency_key": null, "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_postal_code": "10045", "merchant_state": "NY", "route": "visa", "status": "pending_submission", "submission": { "retrieval_reference_number": "123456789012", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "123456" }, "type": "card_validation" }, "properties": { "acceptance": { "additionalProperties": false, "description": "If the validation is accepted by the recipient bank, this will contain supplemental details.", "example": { "accepted_at": "2020-01-31T23:59:59Z", "authorization_identification_response": "ABCDEF", "card_verification_value2_result": null, "cardholder_first_name_result": null, "cardholder_full_name_result": null, "cardholder_last_name_result": null, "cardholder_middle_name_result": null, "cardholder_postal_code_result": null, "cardholder_street_address_result": null, "network_transaction_identifier": "841488484271872" }, "properties": { "accepted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the validation was accepted by the issuing bank.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "authorization_identification_response": { "description": "The authorization identification response from the issuing bank.", "type": "string", "x-documentation-priority": "default" }, "card_verification_value2_result": { "description": "The result of the Card Verification Value 2 match.", "enum": [ "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Card Verification Value 2 (CVV2) matches the expected value.", "The Card Verification Value 2 (CVV2) does not match the expected value." ], "nullable": true }, "cardholder_first_name_result": { "description": "The result of the cardholder first name match.", "enum": [ "match", "no_match", "partial_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder name component matches the expected value.", "The cardholder name component does not match the expected value.", "The cardholder name component partially matches the expected value." ], "nullable": true }, "cardholder_full_name_result": { "description": "The result of the cardholder full name match.", "enum": [ "match", "no_match", "partial_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder name component matches the expected value.", "The cardholder name component does not match the expected value.", "The cardholder name component partially matches the expected value." ], "nullable": true }, "cardholder_last_name_result": { "description": "The result of the cardholder last name match.", "enum": [ "match", "no_match", "partial_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder name component matches the expected value.", "The cardholder name component does not match the expected value.", "The cardholder name component partially matches the expected value." ], "nullable": true }, "cardholder_middle_name_result": { "description": "The result of the cardholder middle name match.", "enum": [ "match", "no_match", "partial_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder name component matches the expected value.", "The cardholder name component does not match the expected value.", "The cardholder name component partially matches the expected value." ], "nullable": true }, "cardholder_postal_code_result": { "description": "The result of the cardholder postal code match.", "enum": [ "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder address component matches the expected value.", "The cardholder address component does not match the expected value." ], "nullable": true }, "cardholder_street_address_result": { "description": "The result of the cardholder street address match.", "enum": [ "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder address component matches the expected value.", "The cardholder address component does not match the expected value." ], "nullable": true }, "network_transaction_identifier": { "description": "A unique identifier for the transaction on the card network.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "accepted_at", "authorization_identification_response", "network_transaction_identifier", "cardholder_full_name_result", "cardholder_first_name_result", "cardholder_middle_name_result", "cardholder_last_name_result", "cardholder_street_address_result", "cardholder_postal_code_result", "card_verification_value2_result" ], "title": "Card Validation Card Validation Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Validation Acceptances", "nullable": true }, "account_id": { "description": "The identifier of the Account from which to send the validation.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "card_token_id": { "description": "The ID of the Card Token that was used to validate the card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" }, "cardholder_first_name": { "description": "The cardholder's first name.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "cardholder_last_name": { "description": "The cardholder's last name.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "cardholder_middle_name": { "description": "The cardholder's middle name.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "cardholder_postal_code": { "description": "The postal code of the cardholder's address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "cardholder_street_address": { "description": "The cardholder's street address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the validation was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the validation, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Card Validation Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Card Validation Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Card Validation Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Card Validation Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "decline": { "additionalProperties": false, "description": "If the validation is rejected by the card network or the destination financial institution, this will contain supplemental details.", "example": { "declined_at": "2020-01-31T23:59:59Z", "network_transaction_identifier": "841488484271872", "reason": "transaction_not_permitted_to_cardholder" }, "properties": { "declined_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the validation was declined.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "network_transaction_identifier": { "description": "A unique identifier for the transaction on the card network.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reason": { "description": "The reason why the validation was declined.", "enum": [ "do_not_honor", "activity_count_limit_exceeded", "refer_to_card_issuer", "refer_to_card_issuer_special_condition", "invalid_merchant", "pick_up_card", "error", "pick_up_card_special", "invalid_transaction", "invalid_amount", "invalid_account_number", "no_such_issuer", "re_enter_transaction", "no_credit_account", "pick_up_card_lost", "pick_up_card_stolen", "closed_account", "insufficient_funds", "no_checking_account", "no_savings_account", "expired_card", "transaction_not_permitted_to_cardholder", "transaction_not_allowed_at_terminal", "transaction_not_supported_or_blocked_by_issuer", "suspected_fraud", "activity_amount_limit_exceeded", "restricted_card", "security_violation", "transaction_does_not_fulfill_anti_money_laundering_requirement", "blocked_by_cardholder", "blocked_first_use", "credit_issuer_unavailable", "negative_card_verification_value_results", "issuer_unavailable", "financial_institution_cannot_be_found", "transaction_cannot_be_completed", "duplicate_transaction", "system_malfunction", "additional_customer_authentication_required", "surcharge_amount_not_permitted", "decline_for_cvv2_failure", "stop_payment_order", "revocation_of_authorization_order", "revocation_of_all_authorizations_order", "unable_to_locate_record", "file_is_temporarily_unavailable", "incorrect_pin", "allowable_number_of_pin_entry_tries_exceeded", "unable_to_locate_previous_message", "pin_error_found", "cannot_verify_pin", "verification_data_failed", "surcharge_amount_not_supported_by_debit_network_issuer", "cash_service_not_available", "cashback_request_exceeds_issuer_limit", "transaction_amount_exceeds_pre_authorized_approval_amount", "transaction_does_not_qualify_for_visa_pin", "offline_declined", "unable_to_go_online", "valid_account_but_amount_not_supported", "invalid_use_of_merchant_category_code_correct_and_reattempt", "card_authentication_failed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card issuer has declined the transaction without providing a specific reason.", "The number of transactions for the card has exceeded the limit set by the issuer.", "The card issuer requires the cardholder to contact them for further information regarding the transaction.", "The card issuer requires the cardholder to contact them due to a special condition related to the transaction.", "The merchant is not valid for this transaction.", "The card should be retained by the terminal.", "An error occurred during processing of the transaction.", "The card should be retained by the terminal due to a special condition.", "The transaction is invalid and cannot be processed.", "The amount of the transaction is invalid.", "The account number provided is invalid.", "The issuer of the card could not be found.", "The transaction should be re-entered for processing.", "There is no credit account associated with the card.", "The card should be retained by the terminal because it has been reported lost.", "The card should be retained by the terminal because it has been reported stolen.", "The account associated with the card has been closed.", "There are insufficient funds in the account to complete the transaction.", "There is no checking account associated with the card.", "There is no savings account associated with the card.", "The card has expired and cannot be used for transactions.", "The transaction is not permitted for this cardholder.", "The transaction is not allowed at this terminal.", "The transaction is not supported or has been blocked by the issuer.", "The transaction has been flagged as suspected fraud and cannot be processed.", "The amount of activity on the card has exceeded the limit set by the issuer.", "The card has restrictions that prevent it from being used for this transaction.", "A security violation has occurred, preventing the transaction from being processed.", "The transaction does not meet the anti-money laundering requirements set by the issuer.", "The transaction was blocked by the cardholder.", "The first use of the card has been blocked by the issuer.", "The credit issuer is currently unavailable to process the transaction.", "The card verification value (CVV) results were negative, indicating a potential issue with the card.", "The issuer of the card is currently unavailable to process the transaction.", "The financial institution associated with the card could not be found.", "The transaction cannot be completed due to an unspecified reason.", "The transaction is a duplicate of a previous transaction and cannot be processed again.", "A system malfunction occurred, preventing the transaction from being processed.", "Additional customer authentication is required to complete the transaction.", "The surcharge amount applied to the transaction is not permitted by the issuer.", "The transaction was declined due to a failure in verifying the CVV2 code.", "A stop payment order has been placed on this transaction.", "An order has been placed to revoke authorization for this transaction.", "An order has been placed to revoke all authorizations for this cardholder.", "The record associated with the transaction could not be located.", "The file needed for the transaction is temporarily unavailable.", "The PIN entered for the transaction is incorrect.", "The allowable number of PIN entry tries has been exceeded.", "The previous message associated with the transaction could not be located.", "An error was found with the PIN associated with the transaction.", "The PIN associated with the transaction could not be verified.", "The verification data associated with the transaction has failed.", "The surcharge amount is not supported by the debit network issuer.", "Cash service is not available for this transaction.", "The cashback request exceeds the issuer limit.", "The transaction amount exceeds the pre-authorized approval amount.", "The transaction does not qualify for Visa PIN processing.", "The transaction was declined offline.", "The terminal was unable to go online to process the transaction.", "The account is valid but the transaction amount is not supported.", "The merchant category code was used incorrectly; correct it and reattempt the transaction.", "The card authentication process has failed." ] } }, "required": [ "declined_at", "reason", "network_transaction_identifier" ], "title": "Card Validation Card Validation Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Validation Declines", "nullable": true }, "id": { "description": "The Card Validation's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Validations" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_category_code": { "description": "A four-digit code (MCC) identifying the type of business or service provided by the merchant.", "type": "string", "x-documentation-priority": "default" }, "merchant_city_name": { "description": "The city where the merchant (typically your business) is located.", "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The postal code for the merchant’s (typically your business’s) location.", "type": "string", "x-documentation-priority": "default" }, "merchant_state": { "description": "The U.S. state where the merchant (typically your business) is located.", "type": "string", "x-documentation-priority": "default" }, "route": { "description": "The card network route used for the validation.", "enum": [ "visa", "mastercard", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa and Interlink", "Mastercard and Maestro", "Pulse" ] }, "status": { "description": "The lifecycle status of the validation.", "enum": [ "requires_attention", "pending_submission", "submitted", "complete", "declined" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The validation requires attention from an Increase operator.", "The validation is queued to be submitted to the card network.", "The validation has been submitted and is pending a response from the card network.", "The validation has been sent successfully and is complete.", "The validation was declined by the network or the recipient's bank." ] }, "submission": { "additionalProperties": false, "description": "After the validation is submitted to the card network, this will contain supplemental details.", "example": { "retrieval_reference_number": "123456789012", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "123456" }, "properties": { "retrieval_reference_number": { "description": "A 12-digit retrieval reference number that identifies the validation. Usually a combination of a timestamp and the trace number.", "type": "string", "x-documentation-priority": "default" }, "submitted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the validation was submitted to the card network.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "trace_number": { "description": "A 6-digit trace number that identifies the validation within a short time window.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "submitted_at", "trace_number", "retrieval_reference_number" ], "title": "Card Validation Card Validation Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Validation Submissions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `card_validation`.", "enum": [ "card_validation" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "card_token_id", "created_at", "created_by", "status", "account_id", "merchant_city_name", "merchant_state", "merchant_postal_code", "merchant_category_code", "merchant_name", "route", "cardholder_first_name", "cardholder_middle_name", "cardholder_last_name", "cardholder_street_address", "cardholder_postal_code", "submission", "decline", "acceptance", "idempotency_key" ], "title": "Card Validation", "type": "object", "x-event-categories": [ "card_validation.created", "card_validation.updated" ], "x-tag": "Card Validations", "x-title-plural": "Card Validations" }, "card_validation_list": { "additionalProperties": true, "description": "A list of Card Validation objects.", "example": { "data": [ { "acceptance": { "accepted_at": "2020-01-31T23:59:59Z", "authorization_identification_response": "ABCDEF", "card_verification_value2_result": null, "cardholder_first_name_result": null, "cardholder_full_name_result": null, "cardholder_last_name_result": null, "cardholder_middle_name_result": null, "cardholder_postal_code_result": null, "cardholder_street_address_result": null, "network_transaction_identifier": "841488484271872" }, "account_id": "account_in71c4amph0vgo2qllky", "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "cardholder_first_name": "Dee", "cardholder_last_name": "Hock", "cardholder_middle_name": "Ward", "cardholder_postal_code": "10045", "cardholder_street_address": "33 Liberty Street", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "decline": { "declined_at": "2020-01-31T23:59:59Z", "network_transaction_identifier": "841488484271872", "reason": "transaction_not_permitted_to_cardholder" }, "id": "outbound_card_validation_qqlzagpc6v1x2gcdhe24", "idempotency_key": null, "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_postal_code": "10045", "merchant_state": "NY", "route": "visa", "status": "pending_submission", "submission": { "retrieval_reference_number": "123456789012", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "123456" }, "type": "card_validation" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/card_validation" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Card Validation List", "type": "object", "x-event-categories": [], "x-title-plural": "Card Validation Lists" }, "check_deposit": { "additionalProperties": true, "description": "Check Deposits allow you to deposit images of paper checks into your account.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "back_image_file_id": "file_26khfk98mzfz90a11oqx", "created_at": "2020-01-31T23:59:59Z", "deposit_acceptance": { "account_number": "987654321", "amount": 1000, "auxiliary_on_us": "101", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "routing_number": "101050001", "serial_number": null }, "deposit_adjustments": [], "deposit_rejection": null, "deposit_return": null, "deposit_submission": { "back_file_id": "file_frhw4s443nh7noss55kq", "front_file_id": "file_j7ed9mrve741m6yui9ju", "submitted_at": "2020-02-01T00:59:59+00:00" }, "description": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "check_deposit_f06n9gpg7sxn8t19lfc1", "idempotency_key": null, "inbound_funds_hold": null, "inbound_mail_item_id": null, "lockbox_recipient_id": null, "status": "submitted", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "check_deposit" }, "properties": { "account_id": { "description": "The Account the check was deposited into.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The deposited amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "back_image_file_id": { "description": "The ID for the File containing the image of the back of the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "deposit_acceptance": { "additionalProperties": true, "description": "Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.", "example": { "account_number": "987654321", "amount": 1000, "auxiliary_on_us": "101", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "routing_number": "101050001", "serial_number": null }, "properties": { "account_number": { "description": "The account number printed on the check. This is an account at the bank that issued the check.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "auxiliary_on_us": { "description": "An additional line of metadata printed on the check. This typically includes the check number for business checks.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "check_deposit_id": { "description": "The ID of the Check Deposit that was accepted.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "routing_number": { "description": "The routing number printed on the check. This is a routing number for the bank that issued the check.", "type": "string", "x-documentation-priority": "default" }, "serial_number": { "description": "The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "amount", "currency", "account_number", "routing_number", "auxiliary_on_us", "serial_number", "check_deposit_id" ], "title": "Check Deposit Check Deposit Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Acceptances", "nullable": true }, "deposit_adjustments": { "description": "If the deposit or the return was adjusted by the receiving institution, this will contain details of the adjustments.", "items": { "additionalProperties": false, "example": { "adjusted_at": "2020-01-31T23:59:59Z", "amount": 1750, "reason": "late_return", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "adjusted_at": { "description": "The time at which the adjustment was received.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The amount of the adjustment.", "type": "integer", "x-documentation-priority": "default" }, "reason": { "description": "The reason for the adjustment.", "enum": [ "adjusted_amount", "non_conforming_item", "paid" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check was deposited with a different amount than what was written on the check.", "The recipient was not able to process the check. This usually happens for e.g., low quality images.", "The check has already been deposited elsewhere and so this is a duplicate." ] }, "transaction_id": { "description": "The id of the transaction for the adjustment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "adjusted_at", "transaction_id", "reason", "amount" ], "title": "Check Deposit Check Deposit Adjustment", "type": "object", "x-event-categories": [], "x-title-plural": "Check Deposit Adjustments" }, "type": "array", "x-documentation-priority": "default" }, "deposit_rejection": { "additionalProperties": true, "description": "If your deposit is rejected by Increase, this will contain details as to why it was rejected.", "example": { "amount": 1750, "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "declined_transaction_id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "reason": "incomplete_image", "rejected_at": "2020-01-31T23:59:59Z" }, "properties": { "amount": { "description": "The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "check_deposit_id": { "description": "The identifier of the Check Deposit that was rejected.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "declined_transaction_id": { "description": "The identifier of the associated declined transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "reason": { "description": "Why the check deposit was rejected.", "enum": [ "incomplete_image", "duplicate", "poor_image_quality", "incorrect_amount", "incorrect_recipient", "not_eligible_for_mobile_deposit", "missing_required_data_elements", "suspected_fraud", "deposit_window_expired", "requested_by_user", "international", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check's image is incomplete.", "This is a duplicate check submission.", "This check has poor image quality.", "The check was deposited with the incorrect amount.", "The check is made out to someone other than the account holder.", "This check was not eligible for mobile deposit.", "This check is missing at least one required field.", "This check is suspected to be fraudulent.", "This check's deposit window has expired.", "The check was rejected at the user's request.", "The check is not a U.S. domestic check and cannot be processed.", "The check was rejected for an unknown reason." ] }, "rejected_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "check_deposit_id", "declined_transaction_id", "amount", "currency", "reason", "rejected_at" ], "title": "Check Deposit Check Deposit Rejection", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Rejections", "nullable": true }, "deposit_return": { "additionalProperties": true, "description": "If your deposit is returned, this will contain details as to why it was returned.", "example": { "amount": 100, "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "return_reason": "insufficient_funds", "returned_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "amount": { "description": "The returned amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "check_deposit_id": { "description": "The identifier of the Check Deposit that was returned.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "return_reason": { "description": "Why this check was returned by the bank holding the account it was drawn against.", "enum": [ "ach_conversion_not_supported", "closed_account", "duplicate_submission", "insufficient_funds", "no_account", "not_authorized", "stale_dated", "stop_payment", "unknown_reason", "unmatched_details", "unreadable_image", "endorsement_irregular", "altered_or_fictitious_item", "frozen_or_blocked_account", "post_dated", "endorsement_missing", "signature_missing", "stop_payment_suspect", "unusable_image", "image_fails_security_check", "cannot_determine_amount", "signature_irregular", "non_cash_item", "unable_to_process", "item_exceeds_dollar_limit", "branch_or_account_sold" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check doesn't allow ACH conversion.", "The account is closed. (Check21 return code `D`)", "The check has already been deposited. (Check21 return code `Y`)", "Insufficient funds (Check21 return code `A`)", "No account was found matching the check details. (Check21 return code `E`)", "The check was not authorized. (Check21 return code `Q`)", "The check is too old. (Check21 return code `G`)", "The payment has been stopped by the account holder. (Check21 return code `C`)", "The reason for the return is unknown.", "The image doesn't match the details submitted.", "The image could not be read. (Check21 return code `U`)", "The check endorsement was irregular. (Check21 return code `J`)", "The check present was either altered or fake. (Check21 return code `N`)", "The account this check is drawn on is frozen. (Check21 return code `F`)", "The check is post dated. (Check21 return code `H`)", "The endorsement was missing. (Check21 return code `I`)", "The check signature was missing. (Check21 return code `K`)", "The bank suspects a stop payment will be placed. (Check21 return code `T`)", "The bank cannot read the image. (Check21 return code `U`)", "The check image fails the bank's security check. (Check21 return code `V`)", "The bank cannot determine the amount. (Check21 return code `W`)", "The signature is inconsistent with prior signatures. (Check21 return code `L`)", "The check is a non-cash item and cannot be drawn against the account. (Check21 return code `M`)", "The bank is unable to process this check. (Check21 return code `O`)", "The check exceeds the bank or customer's limit. (Check21 return code `P`)", "The bank sold this account and no longer services this customer. (Check21 return code `R`)" ] }, "returned_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the transaction that reversed the original check deposit transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "amount", "returned_at", "currency", "check_deposit_id", "transaction_id", "return_reason" ], "title": "Check Deposit Check Deposit Return", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Returns", "nullable": true }, "deposit_submission": { "additionalProperties": false, "description": "After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.", "example": { "back_file_id": "file_frhw4s443nh7noss55kq", "front_file_id": "file_j7ed9mrve741m6yui9ju", "submitted_at": "2020-02-01T00:59:59+00:00" }, "properties": { "back_file_id": { "description": "The ID for the File containing the check back image that was submitted to the Check21 network.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "front_file_id": { "description": "The ID for the File containing the check front image that was submitted to the Check21 network.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "submitted_at": { "description": "When the check deposit was submitted to the Check21 network for processing. During business days, this happens within a few hours of the check being accepted by Increase.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "submitted_at", "front_file_id", "back_file_id" ], "title": "Check Deposit Check Deposit Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Submissions", "nullable": true }, "description": { "description": "The description of the Check Deposit, for display purposes only.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "front_image_file_id": { "description": "The ID for the File containing the image of the front of the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "id": { "description": "The deposit's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "inbound_funds_hold": { "description": "Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_funds_hold" } ], "nullable": true }, "inbound_mail_item_id": { "description": "If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Mail Items", "nullable": true }, "lockbox_recipient_id": { "description": "If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox Recipient, this will contain the identifier of the Lockbox Recipient that received it.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients", "nullable": true }, "status": { "description": "The status of the Check Deposit.", "enum": [ "pending", "submitted", "rejected", "returned" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Check Deposit is pending review.", "The Check Deposit has been deposited.", "The Check Deposit has been rejected.", "The Check Deposit has been returned." ] }, "transaction_id": { "description": "The ID for the Transaction created by the deposit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `check_deposit`.", "enum": [ "check_deposit" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "amount", "description", "created_at", "status", "account_id", "front_image_file_id", "back_image_file_id", "transaction_id", "deposit_acceptance", "deposit_submission", "deposit_rejection", "deposit_return", "inbound_funds_hold", "inbound_mail_item_id", "lockbox_recipient_id", "deposit_adjustments", "idempotency_key" ], "title": "Check Deposit", "type": "object", "x-event-categories": [ "check_deposit.created", "check_deposit.updated" ], "x-tag": "Check Deposits", "x-title-plural": "Check Deposits" }, "check_deposit_list": { "additionalProperties": true, "description": "A list of Check Deposit objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "back_image_file_id": "file_26khfk98mzfz90a11oqx", "created_at": "2020-01-31T23:59:59Z", "deposit_acceptance": { "account_number": "987654321", "amount": 1000, "auxiliary_on_us": "101", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "routing_number": "101050001", "serial_number": null }, "deposit_adjustments": [], "deposit_rejection": null, "deposit_return": null, "deposit_submission": { "back_file_id": "file_frhw4s443nh7noss55kq", "front_file_id": "file_j7ed9mrve741m6yui9ju", "submitted_at": "2020-02-01T00:59:59+00:00" }, "description": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "check_deposit_f06n9gpg7sxn8t19lfc1", "idempotency_key": null, "inbound_funds_hold": null, "inbound_mail_item_id": null, "lockbox_recipient_id": null, "status": "submitted", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "check_deposit" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/check_deposit" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Check Deposit List", "type": "object", "x-event-categories": [], "x-title-plural": "Check Deposit Lists" }, "check_transfer": { "additionalProperties": true, "description": "Check Transfers move funds from your Increase account by mailing a physical check.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 1000, "approval": null, "approved_inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "balance_check": null, "cancellation": null, "check_number": "123", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "fulfillment_method": "physical_check", "id": "check_transfer_30b43acfu9vw8fyc4f5", "idempotency_key": null, "mailing": { "mailed_at": "2020-01-31T23:59:59Z" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "physical_check": { "attachment_file_id": null, "check_voucher_image_file_id": null, "mailing_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "name": "Ian Crease", "phone": "+16505046304", "postal_code": "10045", "state": "NY" }, "memo": "Invoice 29582", "note": null, "payer": [ { "contents": "Ian Crease" }, { "contents": "33 Liberty Street" }, { "contents": "New York, NY 10045" } ], "recipient_name": "Ian Crease", "return_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "name": "Ian Crease", "phone": "+16505046304", "postal_code": "10045", "state": "NY" }, "shipping_method": null, "signature": { "image_file_id": null, "text": "Ian Crease" }, "tracking_updates": [] }, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "mailed", "stop_payment_request": null, "submission": { "preview_file_id": null, "submitted_address": { "city": "NEW YORK", "line1": "33 LIBERTY STREET", "line2": null, "recipient_name": "IAN CREASE", "state": "NY", "zip": "10045" }, "submitted_at": "2020-01-31T23:59:59Z", "tracking_number": null }, "third_party": null, "type": "check_transfer", "valid_until_date": null }, "properties": { "account_id": { "description": "The identifier of the Account from which funds will be transferred.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The account number printed on the check.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "approval": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.", "example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "properties": { "approved_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "approved_by": { "description": "If the Transfer was approved by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "approved_at", "approved_by" ], "title": "Check Transfer Transfer Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Approvals", "nullable": true }, "approved_inbound_check_deposit_id": { "description": "If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits", "nullable": true }, "balance_check": { "description": "How the account's available balance should be checked.", "enum": [ "full", "none" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount. This is the default behavior if `balance_check` is omitted.", "No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created." ], "nullable": true }, "cancellation": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.", "example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null }, "properties": { "canceled_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "canceled_by": { "description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "canceled_by" ], "title": "Check Transfer Transfer Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Cancellations", "nullable": true }, "check_number": { "description": "The check number printed on the check.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Check Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Check Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Check Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Check Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fulfillment_method": { "description": "Whether Increase will print and mail the check or if you will do it yourself.", "enum": [ "physical_check", "third_party" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase will print and mail a physical check.", "Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount." ] }, "id": { "description": "The Check transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "mailing": { "additionalProperties": true, "description": "If the check has been mailed by Increase, this will contain details of the shipment.", "properties": { "mailed_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was mailed.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "mailed_at" ], "title": "Check Transfer Mailing", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Mailings", "nullable": true }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "physical_check": { "additionalProperties": true, "description": "Details relating to the physical check that Increase will print and mail. Will be present if and only if `fulfillment_method` is equal to `physical_check`.", "properties": { "attachment_file_id": { "description": "The ID of the file for the check attachment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "check_voucher_image_file_id": { "description": "The ID of the file for the check voucher image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "mailing_address": { "additionalProperties": false, "description": "Details for where Increase will mail the check.", "properties": { "city": { "description": "The city of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line1": { "description": "The street address of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line2": { "description": "The second line of the address of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "name": { "description": "The name component of the check's mailing address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "phone": { "description": "The phone number to be used in case of delivery issues at the check's mailing address. Only used for FedEx overnight shipping.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The postal code of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The state of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name", "line1", "line2", "city", "state", "postal_code", "phone" ], "title": "Check Transfer PhysicalCheck MailingAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MailingAddresses" }, "memo": { "description": "The descriptor that will be printed on the memo field on the check.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "note": { "description": "The descriptor that will be printed on the letter included with the check.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "payer": { "description": "The payer of the check. This will be printed on the top-left portion of the check and defaults to the return address if unspecified.", "items": { "additionalProperties": false, "properties": { "contents": { "description": "The contents of the line.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "contents" ], "title": "Check Transfer PhysicalCheck PayerElement", "type": "object", "x-event-categories": [], "x-title-plural": "PayerElements" }, "type": "array", "x-documentation-priority": "default" }, "recipient_name": { "description": "The name that will be printed on the check.", "type": "string", "x-documentation-priority": "default" }, "return_address": { "additionalProperties": false, "description": "The return address to be printed on the check.", "properties": { "city": { "description": "The city of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line1": { "description": "The street address of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line2": { "description": "The second line of the address of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "name": { "description": "The name component of the check's return address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "phone": { "description": "The shipper's phone number to be used in case of delivery issues. Only used for FedEx overnight shipping.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The postal code of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The state of the check's destination.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name", "line1", "line2", "city", "state", "postal_code", "phone" ], "title": "Check Transfer PhysicalCheck ReturnAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ReturnAddresses", "nullable": true }, "shipping_method": { "description": "The shipping method for the check.", "enum": [ "usps_first_class", "fedex_overnight" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "USPS First Class", "FedEx Overnight" ], "nullable": true }, "signature": { "additionalProperties": false, "description": "The signature that will appear on the check.", "properties": { "image_file_id": { "description": "The ID of a File containing a PNG of the signature.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "text": { "description": "The text that will appear as the signature on the check in cursive font.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "text", "image_file_id" ], "title": "Check Transfer PhysicalCheck Signature", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Signatures" }, "tracking_updates": { "description": "Tracking updates relating to the physical check's delivery.", "items": { "additionalProperties": false, "properties": { "category": { "description": "The type of tracking event.", "enum": [ "in_transit", "processed_for_delivery", "delivered", "delivery_issue", "returned_to_sender" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check is in transit.", "The check has been processed for delivery.", "The check has been delivered.", "There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender.", "Delivery failed and the check was returned to sender." ] }, "country": { "description": "The ISO 3166-1 alpha-2 country code for the country where the event took place.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the tracking event took place.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code where the event took place.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "category", "created_at", "postal_code", "country" ], "title": "Check Transfer PhysicalCheck TrackingUpdatesElement", "type": "object", "x-event-categories": [], "x-title-plural": "TrackingUpdatesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "memo", "note", "recipient_name", "signature", "shipping_method", "attachment_file_id", "check_voucher_image_file_id", "mailing_address", "return_address", "payer", "tracking_updates" ], "title": "Check Transfer PhysicalCheck", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "PhysicalChecks", "nullable": true }, "routing_number": { "description": "The routing number printed on the check.", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The identifier of the Account Number from which to send the transfer and print on the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers", "nullable": true }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "canceled", "pending_submission", "requires_attention", "rejected", "pending_mailing", "mailed", "deposited", "stopped", "returned" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is awaiting approval.", "The transfer has been canceled.", "The transfer is pending submission.", "The transfer requires attention from an Increase operator.", "The transfer has been rejected.", "The check is queued for mailing.", "The check has been mailed.", "The check has been deposited.", "A stop-payment was requested for this check.", "The transfer has been returned." ] }, "stop_payment_request": { "description": "After a stop-payment is requested on the check, this will contain supplemental details.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/check_transfer_stop_payment_request" } ], "nullable": true }, "submission": { "additionalProperties": true, "description": "After the transfer is submitted, this will contain supplemental details.", "example": { "preview_file_id": null, "submitted_address": { "city": "NEW YORK", "line1": "33 LIBERTY STREET", "line2": null, "recipient_name": "IAN CREASE", "state": "NY", "zip": "10045" }, "submitted_at": "2020-01-31T23:59:59Z", "tracking_number": null }, "properties": { "preview_file_id": { "description": "The ID of the file corresponding to an image of the check that was mailed, if available.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "submitted_address": { "additionalProperties": false, "description": "The address we submitted to the printer. This is what is physically printed on the check.", "properties": { "city": { "description": "The submitted address city.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The submitted address line 1.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The submitted address line 2.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "recipient_name": { "description": "The submitted recipient name.", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The submitted address state.", "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The submitted address zip.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "recipient_name", "line1", "line2", "city", "state", "zip" ], "title": "Check Transfer Physical Check Submission SubmittedAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "SubmittedAddresses" }, "submitted_at": { "description": "When this check was submitted to our check printer.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "The tracking number for the check shipment.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "submitted_at", "tracking_number", "preview_file_id", "submitted_address" ], "title": "Check Transfer Physical Check Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Physical Check Submissions", "nullable": true }, "third_party": { "additionalProperties": true, "description": "Details relating to the custom fulfillment you will perform. Will be present if and only if `fulfillment_method` is equal to `third_party`.", "properties": { "recipient_name": { "description": "The name that you will print on the check.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "recipient_name" ], "title": "Check Transfer ThirdParty", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ThirdParties", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `check_transfer`.", "enum": [ "check_transfer" ], "type": "string", "x-documentation-priority": "default" }, "valid_until_date": { "description": "If set, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "type", "account_id", "source_account_number_id", "account_number", "routing_number", "check_number", "valid_until_date", "balance_check", "fulfillment_method", "physical_check", "third_party", "amount", "created_at", "currency", "approval", "cancellation", "id", "mailing", "pending_transaction_id", "status", "submission", "stop_payment_request", "approved_inbound_check_deposit_id", "created_by", "idempotency_key" ], "title": "Check Transfer", "type": "object", "x-event-categories": [ "check_transfer.created", "check_transfer.updated" ], "x-tag": "Check Transfers", "x-title-plural": "Check Transfers" }, "check_transfer_deposit": { "additionalProperties": true, "description": "An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered.", "example": { "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "bank_of_first_deposit_routing_number": null, "deposited_at": "2020-01-31T23:59:59Z", "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "type": "check_transfer_deposit" }, "properties": { "back_image_file_id": { "description": "The identifier of the API File object containing an image of the back of the deposited check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "bank_of_first_deposit_routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "deposited_at": { "description": "When the check was deposited.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "front_image_file_id": { "description": "The identifier of the API File object containing an image of the front of the deposited check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "inbound_check_deposit_id": { "description": "The identifier of the Inbound Check Deposit object associated with this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits", "nullable": true }, "transaction_id": { "description": "The identifier of the Transaction object created when the check was deposited.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "transfer_id": { "description": "The identifier of the Check Transfer object that was deposited.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.", "enum": [ "check_transfer_deposit" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "deposited_at", "transaction_id", "front_image_file_id", "back_image_file_id", "bank_of_first_deposit_routing_number", "inbound_check_deposit_id", "transfer_id" ], "title": "Check Transfer Deposit", "type": "object", "x-event-categories": [], "x-title-plural": "Check Transfer Deposits" }, "check_transfer_list": { "additionalProperties": true, "description": "A list of Check Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 1000, "approval": null, "approved_inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "balance_check": null, "cancellation": null, "check_number": "123", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "fulfillment_method": "physical_check", "id": "check_transfer_30b43acfu9vw8fyc4f5", "idempotency_key": null, "mailing": { "mailed_at": "2020-01-31T23:59:59Z" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "physical_check": { "attachment_file_id": null, "check_voucher_image_file_id": null, "mailing_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "name": "Ian Crease", "phone": "+16505046304", "postal_code": "10045", "state": "NY" }, "memo": "Invoice 29582", "note": null, "payer": [ { "contents": "Ian Crease" }, { "contents": "33 Liberty Street" }, { "contents": "New York, NY 10045" } ], "recipient_name": "Ian Crease", "return_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "name": "Ian Crease", "phone": "+16505046304", "postal_code": "10045", "state": "NY" }, "shipping_method": null, "signature": { "image_file_id": null, "text": "Ian Crease" }, "tracking_updates": [] }, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "mailed", "stop_payment_request": null, "submission": { "preview_file_id": null, "submitted_address": { "city": "NEW YORK", "line1": "33 LIBERTY STREET", "line2": null, "recipient_name": "IAN CREASE", "state": "NY", "zip": "10045" }, "submitted_at": "2020-01-31T23:59:59Z", "tracking_number": null }, "third_party": null, "type": "check_transfer", "valid_until_date": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/check_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Check Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Check Transfer Lists" }, "check_transfer_stop_payment_request": { "additionalProperties": true, "description": "A Check Transfer Stop Payment Request is created when a check transfer is stopped. It offsets the Check Transfer Intention.", "example": { "reason": "mail_delivery_failed", "requested_at": "2020-01-31T23:59:59Z", "transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "type": "check_transfer_stop_payment_request" }, "properties": { "reason": { "description": "The reason why this transfer was stopped.", "enum": [ "mail_delivery_failed", "rejected_by_increase", "not_authorized", "valid_until_date_passed", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check could not be delivered.", "The check was canceled by an Increase operator who will provide details out-of-band.", "The check was not authorized.", "The check was stopped for `valid_until_date` being in the past.", "The check was stopped for another reason." ] }, "requested_at": { "description": "The time the stop-payment was requested.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The ID of the check transfer that was stopped.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.", "enum": [ "check_transfer_stop_payment_request" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "transfer_id", "reason", "requested_at" ], "title": "Check Transfer Stop Payment Request", "type": "object", "x-event-categories": [], "x-title-plural": "Check Transfer Stop Payment Requests" }, "clone_a_physical_card_profile_parameters": { "additionalProperties": true, "example": { "front_image_file_id": "file_o6aex13wm1jcc36sgcj1" }, "properties": { "carrier_image_file_id": { "description": "The identifier of the File containing the physical card's carrier image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "contact_phone": { "description": "A phone number the user can contact to receive support for their card.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description you can use to identify the Card Profile.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "front_image_file_id": { "description": "The identifier of the File containing the physical card's front image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "front_text": { "additionalProperties": false, "description": "Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.", "properties": { "line1": { "description": "The first line of text on the front of the card.", "maxLength": 33, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of text on the front of the card. Providing a second line moves the first line slightly higher and prints the second line in the spot where the first line would have otherwise been printed.", "maxLength": 33, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "program_id": { "description": "The identifier of the Program to use for the cloned Physical Card Profile.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" } }, "type": "object", "x-event-categories": [] }, "clones_a_digital_card_profile_parameters": { "additionalProperties": true, "example": { "background_image_file_id": "file_1ai913suu1zfn1pdetru" }, "properties": { "app_icon_file_id": { "description": "The identifier of the File containing the card's icon image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "background_image_file_id": { "description": "The identifier of the File containing the card's front image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "card_description": { "description": "A user-facing description for the card itself.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "contact_email": { "description": "An email address the user can contact to receive support for their card.", "format": "email", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "contact_phone": { "description": "A phone number the user can contact to receive support for their card.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "contact_website": { "description": "A website the user can visit to view and receive support for their card.", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description you can use to identify the Card Profile.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "issuer_name": { "description": "A user-facing description for whoever is issuing the card.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "text_color": { "additionalProperties": false, "description": "The Card's text color, specified as an RGB triple. The default is white.", "properties": { "blue": { "description": "The value of the blue channel in the RGB color.", "maximum": 255, "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "green": { "description": "The value of the green channel in the RGB color.", "maximum": 255, "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "red": { "description": "The value of the red channel in the RGB color.", "maximum": 255, "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "red", "green", "blue" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-event-categories": [] }, "create_a_beneficial_owner_parameters": { "additionalProperties": true, "example": { "company_title": "CEO", "entity_id": "entity_n8y8tnk2p9339ti393yi", "individual": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number": "078051120" }, "name": "Ian Crease" }, "prongs": [ "control" ] }, "properties": { "company_title": { "description": "This person's role or title within the entity.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "entity_id": { "description": "The identifier of the Entity to associate with the new Beneficial Owner.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "individual": { "additionalProperties": false, "description": "Personal details for the beneficial owner.", "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "prongs": { "description": "Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both.", "items": { "enum": [ "ownership", "control" ], "type": "string", "x-enum-descriptions": [ "A person with 25% or greater direct or indirect ownership of the entity.", "A person who manages, directs, or has significant control of the entity." ] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "entity_id", "prongs", "individual" ], "type": "object", "x-event-categories": [] }, "create_a_card_details_iframe_parameters": { "additionalProperties": false, "example": {}, "properties": { "physical_card_id": { "description": "The identifier of the Physical Card to create an iframe for. This will inform the appearance of the card rendered in the iframe.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" } }, "type": "object", "x-event-categories": [] }, "create_a_card_dispute_parameters": { "additionalProperties": true, "example": { "amount": 100, "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "network": "visa", "visa": { "category": "fraud", "fraud": { "fraud_type": "account_or_credentials_takeover" } } }, "properties": { "amount": { "description": "The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "attachment_files": { "description": "The files to be attached to the initial dispute submission.", "items": { "additionalProperties": false, "properties": { "file_id": { "description": "The ID of the file to be attached. The file must have a `purpose` of `card_dispute_attachment`.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "disputed_transaction_id": { "description": "The Transaction you wish to dispute. This Transaction must have a `source_type` of `card_settlement`.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "explanation": { "description": "The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "network": { "description": "The network of the disputed transaction. Details specific to the network are required under the sub-object with the same identifier as the network.", "enum": [ "visa" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa" ] }, "visa": { "additionalProperties": false, "description": "The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`.", "properties": { "authorization": { "additionalProperties": false, "description": "Authorization. Required if and only if `category` is `authorization`.", "properties": { "account_status": { "description": "Account status.", "enum": [ "account_closed", "credit_problem", "fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account closed.", "Credit problem.", "Fraud." ] } }, "required": [ "account_status" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "category": { "description": "Category.", "enum": [ "authorization", "consumer_canceled_merchandise", "consumer_canceled_recurring_transaction", "consumer_canceled_services", "consumer_counterfeit_merchandise", "consumer_credit_not_processed", "consumer_damaged_or_defective_merchandise", "consumer_merchandise_misrepresentation", "consumer_merchandise_not_as_described", "consumer_merchandise_not_received", "consumer_non_receipt_of_cash", "consumer_original_credit_transaction_not_accepted", "consumer_quality_merchandise", "consumer_quality_services", "consumer_services_misrepresentation", "consumer_services_not_as_described", "consumer_services_not_received", "fraud", "processing_error" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Authorization.", "Consumer: canceled merchandise.", "Consumer: canceled recurring transaction.", "Consumer: canceled services.", "Consumer: counterfeit merchandise.", "Consumer: credit not processed.", "Consumer: damaged or defective merchandise.", "Consumer: merchandise misrepresentation.", "Consumer: merchandise not as described.", "Consumer: merchandise not received.", "Consumer: non-receipt of cash.", "Consumer: Original Credit Transaction (OCT) not accepted.", "Consumer: merchandise quality issue.", "Consumer: services quality issue.", "Consumer: services misrepresentation.", "Consumer: services not as described.", "Consumer: services not received.", "Fraud.", "Processing error." ] }, "consumer_canceled_merchandise": { "additionalProperties": false, "description": "Canceled merchandise. Required if and only if `category` is `consumer_canceled_merchandise`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "canceled_prior_to_ship_date": { "description": "Canceled prior to ship date.", "enum": [ "canceled_prior_to_ship_date", "not_canceled_prior_to_ship_date" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Canceled prior to ship date.", "Not canceled prior to ship date." ] }, "cancellation_policy_provided": { "description": "Cancellation policy provided.", "enum": [ "not_provided", "provided" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not provided.", "Provided." ] }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at", "canceled_prior_to_ship_date", "cancellation_policy_provided", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_or_expected_at": { "description": "Received or expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "purchase_explanation", "received_or_expected_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_canceled_recurring_transaction": { "additionalProperties": false, "description": "Canceled recurring transaction. Required if and only if `category` is `consumer_canceled_recurring_transaction`.", "properties": { "cancellation_target": { "description": "Cancellation target.", "enum": [ "account", "transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account.", "Transaction." ] }, "merchant_contact_methods": { "additionalProperties": false, "description": "Merchant contact methods.", "properties": { "application_name": { "description": "Application name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "call_center_phone_number": { "description": "Call center phone number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "email_address": { "description": "Email address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "in_person_address": { "description": "In person address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "mailing_address": { "description": "Mailing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "text_phone_number": { "description": "Text phone number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "other_form_of_payment_explanation": { "description": "Other form of payment explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "transaction_or_account_canceled_at": { "description": "Transaction or account canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_target", "merchant_contact_methods", "transaction_or_account_canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_canceled_services": { "additionalProperties": false, "description": "Canceled services. Required if and only if `category` is `consumer_canceled_services`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "cancellation_policy_provided": { "description": "Cancellation policy provided.", "enum": [ "not_provided", "provided" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not provided.", "Provided." ] }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at", "cancellation_policy_provided", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "contracted_at": { "description": "Contracted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "guaranteed_reservation": { "additionalProperties": false, "description": "Guaranteed reservation explanation. Required if and only if `service_type` is `guaranteed_reservation`.", "properties": { "explanation": { "description": "Explanation.", "enum": [ "cardholder_canceled_prior_to_service", "cardholder_cancellation_attempt_within_24_hours_of_confirmation", "merchant_billed_no_show" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder canceled prior to service.", "Cardholder cancellation attempt within 24 hours of confirmation.", "Merchant billed for no-show." ] } }, "required": [ "explanation" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "other": { "additionalProperties": false, "description": "Other service type explanation. Required if and only if `service_type` is `other`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "service_type": { "description": "Service type.", "enum": [ "guaranteed_reservation", "other", "timeshare" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Guaranteed reservation.", "Other.", "Timeshare." ] }, "timeshare": { "additionalProperties": false, "description": "Timeshare explanation. Required if and only if `service_type` is `timeshare`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "cardholder_cancellation", "contracted_at", "merchant_resolution_attempted", "purchase_explanation", "service_type" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_counterfeit_merchandise": { "additionalProperties": false, "description": "Counterfeit merchandise. Required if and only if `category` is `consumer_counterfeit_merchandise`.", "properties": { "counterfeit_explanation": { "description": "Counterfeit explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "disposition_explanation": { "description": "Disposition explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "order_explanation": { "description": "Order explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "counterfeit_explanation", "disposition_explanation", "order_explanation", "received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_credit_not_processed": { "additionalProperties": false, "description": "Credit not processed. Required if and only if `category` is `consumer_credit_not_processed`.", "properties": { "canceled_or_returned_at": { "description": "Canceled or returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "credit_expected_at": { "description": "Credit expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_damaged_or_defective_merchandise": { "additionalProperties": false, "description": "Damaged or defective merchandise. Required if and only if `category` is `consumer_damaged_or_defective_merchandise`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "order_and_issue_explanation": { "description": "Order and issue explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "order_and_issue_explanation", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_merchandise_misrepresentation": { "additionalProperties": false, "description": "Merchandise misrepresentation. Required if and only if `category` is `consumer_merchandise_misrepresentation`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "misrepresentation_explanation": { "description": "Misrepresentation explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "misrepresentation_explanation", "purchase_explanation", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_merchandise_not_as_described": { "additionalProperties": false, "description": "Merchandise not as described. Required if and only if `category` is `consumer_merchandise_not_as_described`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_merchandise_not_received": { "additionalProperties": false, "description": "Merchandise not received. Required if and only if `category` is `consumer_merchandise_not_received`.", "properties": { "cancellation_outcome": { "description": "Cancellation outcome.", "enum": [ "cardholder_cancellation_prior_to_expected_receipt", "merchant_cancellation", "no_cancellation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder cancellation prior to expected receipt.", "Merchant cancellation.", "No cancellation." ] }, "cardholder_cancellation_prior_to_expected_receipt": { "additionalProperties": false, "description": "Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "delayed": { "additionalProperties": false, "description": "Delayed. Required if and only if `delivery_issue` is `delayed`.", "properties": { "explanation": { "description": "Explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempted_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "merchant_received_return_at", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "explanation", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "delivered_to_wrong_location": { "additionalProperties": false, "description": "Delivered to wrong location. Required if and only if `delivery_issue` is `delivered_to_wrong_location`.", "properties": { "agreed_location": { "description": "Agreed location.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "agreed_location" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "delivery_issue": { "description": "Delivery issue.", "enum": [ "delayed", "delivered_to_wrong_location" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Delayed.", "Delivered to wrong location." ] }, "last_expected_receipt_at": { "description": "Last expected receipt at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_cancellation": { "additionalProperties": false, "description": "Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "no_cancellation": { "additionalProperties": false, "description": "No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_explanation": { "description": "Purchase information and explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_outcome", "delivery_issue", "last_expected_receipt_at", "merchant_resolution_attempted", "purchase_info_and_explanation" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_non_receipt_of_cash": { "additionalProperties": false, "description": "Non-receipt of cash. Required if and only if `category` is `consumer_non_receipt_of_cash`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_original_credit_transaction_not_accepted": { "additionalProperties": false, "description": "Original Credit Transaction (OCT) not accepted. Required if and only if `category` is `consumer_original_credit_transaction_not_accepted`.", "properties": { "explanation": { "description": "Explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "enum": [ "prohibited_by_local_laws_or_regulation", "recipient_refused" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Prohibited by local laws or regulation.", "Recipient refused." ] } }, "required": [ "explanation", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_quality_merchandise": { "additionalProperties": false, "description": "Merchandise quality issue. Required if and only if `category` is `consumer_quality_merchandise`.", "properties": { "expected_at": { "description": "Expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "ongoing_negotiations": { "additionalProperties": false, "description": "Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations.", "properties": { "explanation": { "description": "Explanation of the previous ongoing negotiations between the cardholder and merchant.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "issuer_first_notified_at": { "description": "Date the cardholder first notified the issuer of the dispute.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "started_at": { "description": "Started at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "issuer_first_notified_at", "started_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_quality_issue": { "description": "Purchase information and quality issue.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "expected_at", "merchant_resolution_attempted", "purchase_info_and_quality_issue", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_quality_services": { "additionalProperties": false, "description": "Services quality issue. Required if and only if `category` is `consumer_quality_services`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "cardholder_paid_to_have_work_redone": { "description": "Cardholder paid to have work redone.", "enum": [ "did_not_pay_to_have_work_redone", "paid_to_have_work_redone" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder did not pay to have work redone.", "Cardholder paid to have work redone." ] }, "non_fiat_currency_or_non_fungible_token_related_and_not_matching_description": { "description": "Non-fiat currency or non-fungible token related and not matching description.", "enum": [ "not_related", "related" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not related.", "Related." ] }, "ongoing_negotiations": { "additionalProperties": false, "description": "Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations.", "properties": { "explanation": { "description": "Explanation of the previous ongoing negotiations between the cardholder and merchant.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "issuer_first_notified_at": { "description": "Date the cardholder first notified the issuer of the dispute.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "started_at": { "description": "Started at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "issuer_first_notified_at", "started_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_quality_issue": { "description": "Purchase information and quality issue.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "restaurant_food_related": { "description": "Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814.", "enum": [ "not_related", "related" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not related.", "Related." ] }, "services_received_at": { "description": "Services received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "non_fiat_currency_or_non_fungible_token_related_and_not_matching_description", "purchase_info_and_quality_issue", "services_received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_services_misrepresentation": { "additionalProperties": false, "description": "Services misrepresentation. Required if and only if `category` is `consumer_services_misrepresentation`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "misrepresentation_explanation": { "description": "Misrepresentation explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "merchant_resolution_attempted", "misrepresentation_explanation", "purchase_explanation", "received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_services_not_as_described": { "additionalProperties": false, "description": "Services not as described. Required if and only if `category` is `consumer_services_not_as_described`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "explanation": { "description": "Explanation of what was ordered and was not as described.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "explanation", "merchant_resolution_attempted", "received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_services_not_received": { "additionalProperties": false, "description": "Services not received. Required if and only if `category` is `consumer_services_not_received`.", "properties": { "cancellation_outcome": { "description": "Cancellation outcome.", "enum": [ "cardholder_cancellation_prior_to_expected_receipt", "merchant_cancellation", "no_cancellation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder cancellation prior to expected receipt.", "Merchant cancellation.", "No cancellation." ] }, "cardholder_cancellation_prior_to_expected_receipt": { "additionalProperties": false, "description": "Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "last_expected_receipt_at": { "description": "Last expected receipt at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_cancellation": { "additionalProperties": false, "description": "Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "no_cancellation": { "additionalProperties": false, "description": "No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_explanation": { "description": "Purchase information and explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_outcome", "last_expected_receipt_at", "merchant_resolution_attempted", "purchase_info_and_explanation" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "fraud": { "additionalProperties": false, "description": "Fraud. Required if and only if `category` is `fraud`.", "properties": { "fraud_type": { "description": "Fraud type.", "enum": [ "account_or_credentials_takeover", "card_not_received_as_issued", "fraudulent_application", "fraudulent_use_of_account_number", "incorrect_processing", "issuer_reported_counterfeit", "lost", "manipulation_of_account_holder", "merchant_misrepresentation", "miscellaneous", "stolen" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account or credentials takeover.", "Card not received as issued.", "Fraudulent application.", "Fraudulent use of account number.", "Incorrect processing.", "Issuer reported counterfeit.", "Lost.", "Manipulation of account holder.", "Merchant misrepresentation.", "Miscellaneous.", "Stolen." ] } }, "required": [ "fraud_type" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "processing_error": { "additionalProperties": false, "description": "Processing error. Required if and only if `category` is `processing_error`.", "properties": { "duplicate_transaction": { "additionalProperties": false, "description": "Duplicate transaction. Required if and only if `error_reason` is `duplicate_transaction`.", "properties": { "other_transaction_id": { "description": "Other transaction ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "other_transaction_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "error_reason": { "description": "Error reason.", "enum": [ "duplicate_transaction", "incorrect_amount", "paid_by_other_means" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Duplicate transaction.", "Incorrect amount.", "Paid by other means." ] }, "incorrect_amount": { "additionalProperties": false, "description": "Incorrect amount. Required if and only if `error_reason` is `incorrect_amount`.", "properties": { "expected_amount": { "description": "Expected amount.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "expected_amount" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "paid_by_other_means": { "additionalProperties": false, "description": "Paid by other means. Required if and only if `error_reason` is `paid_by_other_means`.", "properties": { "other_form_of_payment_evidence": { "description": "Other form of payment evidence.", "enum": [ "canceled_check", "card_transaction", "cash_receipt", "other", "statement", "voucher" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Canceled check.", "Card transaction.", "Cash receipt.", "Other.", "Statement.", "Voucher." ] }, "other_transaction_id": { "description": "Other transaction ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "other_form_of_payment_evidence" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "error_reason", "merchant_resolution_attempted" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "disputed_transaction_id", "network" ], "type": "object", "x-event-categories": [] }, "create_a_card_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "description": "Card for Ian Crease" }, "properties": { "account_id": { "description": "The Account the card should belong to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "authorization_controls": { "additionalProperties": false, "description": "Controls that restrict how this card can be used.", "properties": { "merchant_acceptor_identifier": { "additionalProperties": false, "description": "Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The Merchant Acceptor IDs that are allowed for authorizations on this card. Authorizations with Merchant Acceptor IDs not in this list will be declined.", "items": { "additionalProperties": false, "properties": { "identifier": { "description": "The Merchant Acceptor ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "identifier" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "blocked": { "description": "The Merchant Acceptor IDs that are blocked for authorizations on this card. Authorizations with Merchant Acceptor IDs in this list will be declined.", "items": { "additionalProperties": false, "properties": { "identifier": { "description": "The Merchant Acceptor ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "identifier" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_category_code": { "additionalProperties": false, "description": "Restricts which Merchant Category Codes are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The Merchant Category Codes that are allowed for authorizations on this card. Authorizations with Merchant Category Codes not in this list will be declined.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "blocked": { "description": "The Merchant Category Codes that are blocked for authorizations on this card. Authorizations with Merchant Category Codes in this list will be declined.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_country": { "additionalProperties": false, "description": "Restricts which merchant countries are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The merchant countries that are allowed for authorizations on this card. Authorizations with merchant countries not in this list will be declined.", "items": { "additionalProperties": false, "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "type": "string", "x-documentation-priority": "default" } }, "required": [ "country" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "blocked": { "description": "The merchant countries that are blocked for authorizations on this card. Authorizations with merchant countries in this list will be declined.", "items": { "additionalProperties": false, "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "type": "string", "x-documentation-priority": "default" } }, "required": [ "country" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "usage": { "additionalProperties": false, "description": "Controls how many times this card can be used.", "properties": { "category": { "description": "Whether the card is for a single use or multiple uses.", "enum": [ "single_use", "multi_use" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card can only be used for a single authorization.", "The card can be used for multiple authorizations." ] }, "multi_use": { "additionalProperties": false, "description": "Controls for multi-use cards. Required if and only if `category` is `multi_use`.", "properties": { "spending_limits": { "description": "Spending limits for this card. The most restrictive limit applies if multiple limits match.", "items": { "additionalProperties": false, "properties": { "interval": { "description": "The interval at which the spending limit is enforced.", "enum": [ "all_time", "per_transaction", "per_day", "per_week", "per_month" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The spending limit applies over the lifetime of the card.", "The spending limit applies per transaction.", "The spending limit applies per day. Resets nightly at midnight UTC.", "The spending limit applies per week. Resets weekly on Mondays at midnight UTC.", "The spending limit applies per month. Resets on the first of the month, midnight UTC." ] }, "merchant_category_codes": { "description": "The Merchant Category Codes this spending limit applies to. If not set, the limit applies to all transactions.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "settlement_amount": { "description": "The maximum settlement amount permitted in the given interval.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "interval", "settlement_amount" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "single_use": { "additionalProperties": false, "description": "Controls for single-use cards. Required if and only if `category` is `single_use`.", "properties": { "settlement_amount": { "additionalProperties": false, "description": "The settlement amount constraint for this single-use card.", "properties": { "comparison": { "description": "The operator used to compare the settlement amount.", "enum": [ "equals", "less_than_or_equals" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The settlement amount must be exactly the specified value.", "The settlement amount must be less than or equal to the specified value." ] }, "value": { "description": "The settlement amount value.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "value", "comparison" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "settlement_amount" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "billing_address": { "additionalProperties": false, "description": "The card's billing address.", "properties": { "city": { "description": "The city of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The US state of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "description": { "description": "The description you choose to give the card.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "digital_wallet": { "additionalProperties": false, "description": "The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category `digital_wallet_token_requested` or `digital_wallet_authentication_requested`.", "properties": { "digital_card_profile_id": { "description": "The digital card profile assigned to this digital card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles" }, "email": { "description": "An email address that can be used to contact and verify the cardholder via one-time passcode over email.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "A phone number that can be used to contact and verify the cardholder via one-time passcode over SMS.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "entity_id": { "description": "The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } }, "required": [ "account_id" ], "type": "object", "x-event-categories": [] }, "create_a_card_push_transfer_parameters": { "additionalProperties": true, "example": { "business_application_identifier": "funds_disbursement", "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_name_prefix": "Acme", "merchant_postal_code": "10045", "merchant_state": "NY", "presentment_amount": { "currency": "USD", "value": "1234.56" }, "recipient_name": "Ian Crease", "sender_address_city": "New York", "sender_address_line1": "33 Liberty Street", "sender_address_postal_code": "10045", "sender_address_state": "NY", "sender_name": "Ian Crease", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2" }, "properties": { "business_application_identifier": { "description": "The Business Application Identifier describes the type of transaction being performed. Your program must be approved for the specified Business Application Identifier in order to use it.", "enum": [ "account_to_account", "business_to_business", "money_transfer_bank_initiated", "non_card_bill_payment", "consumer_bill_payment", "card_bill_payment", "funds_disbursement", "funds_transfer", "loyalty_and_offers", "merchant_disbursement", "merchant_payment", "person_to_person", "top_up", "wallet_transfer" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account to Account", "Business to Business", "Money Transfer Bank Initiated", "Non-Card Bill Payment", "Consumer Bill Payment", "Card Bill Payment", "Funds Disbursement", "Funds Transfer", "Loyalty and Offers", "Merchant Disbursement", "Merchant Payment", "Person to Person", "Top Up", "Wallet Transfer" ] }, "card_token_id": { "description": "The Increase identifier for the Card Token that represents the card number you're pushing funds to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" }, "merchant_category_code": { "description": "The merchant category code (MCC) of the merchant (generally your business) sending the transfer. This is a four-digit code that describes the type of business or service provided by the merchant. Your program must be approved for the specified MCC in order to use it.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_city_name": { "description": "The city name of the merchant (generally your business) sending the transfer.", "maxLength": 13, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_legal_business_name": { "description": "The legal business name of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada.", "maxLength": 25, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The merchant name shows up as the statement descriptor for the transfer. This is typically the name of your business or organization.", "maxLength": 25, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_name_prefix": { "description": "For certain Business Application Identifiers, the statement descriptor is `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to four character prefix that identifies the merchant.", "maxLength": 4, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The postal code of the merchant (generally your business) sending the transfer.", "maxLength": 10, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_state": { "description": "The state of the merchant (generally your business) sending the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_street_address": { "description": "The street address of the merchant (generally your business) sending the transfer. Required if the card is issued in Canada.", "maxLength": 99, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "presentment_amount": { "additionalProperties": false, "description": "The amount to transfer. The receiving bank will convert this to the cardholder's currency. The amount that is applied to your Increase account matches the currency of your account.", "properties": { "currency": { "description": "The ISO 4217 currency code representing the currency of the amount.", "enum": [ "AFN", "EUR", "ALL", "DZD", "USD", "AOA", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "INR", "BTN", "BOB", "BOV", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "CAD", "KYD", "CLP", "CLF", "CNY", "COP", "COU", "KMF", "CDF", "NZD", "CRC", "CUP", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "SZL", "ETB", "FKP", "FJD", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "MXN", "MXV", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLE", "SGD", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SEK", "CHE", "CHW", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "USN", "UYU", "UYI", "UYW", "UZS", "VUV", "VES", "VED", "VND", "YER", "ZMW", "ZWG" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "AFN", "EUR", "ALL", "DZD", "USD", "AOA", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "INR", "BTN", "BOB", "BOV", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "CAD", "KYD", "CLP", "CLF", "CNY", "COP", "COU", "KMF", "CDF", "NZD", "CRC", "CUP", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "SZL", "ETB", "FKP", "FJD", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "MXN", "MXV", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLE", "SGD", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SEK", "CHE", "CHW", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "USN", "UYU", "UYI", "UYW", "UZS", "VUV", "VES", "VED", "VND", "YER", "ZMW", "ZWG" ] }, "value": { "description": "The amount value as a decimal string in the currency's major unit. For example, for USD, '1234.56' represents 1234 dollars and 56 cents. For JPY, '1234' represents 1234 yen. A currency with minor units requires at least one decimal place and supports up to the number of decimal places defined by the currency's minor units. A currency without minor units does not support any decimal places.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "value", "currency" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "recipient_address_city": { "description": "The city of the recipient. Required if the card is issued in Canada.", "maxLength": 25, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "recipient_address_line1": { "description": "The first line of the recipient's address. Required if the card is issued in Canada.", "maxLength": 99, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "recipient_address_postal_code": { "description": "The postal code of the recipient. Required if the card is issued in Canada.", "maxLength": 16, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "recipient_address_state": { "description": "The state or province of the recipient. Required if the card is issued in Canada.", "maxLength": 3, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "recipient_name": { "description": "The name of the funds recipient.", "maxLength": 30, "minLength": 2, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "sender_address_city": { "description": "The city of the sender.", "maxLength": 25, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "sender_address_line1": { "description": "The address line 1 of the sender.", "maxLength": 35, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "sender_address_postal_code": { "description": "The postal code of the sender.", "maxLength": 10, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "sender_address_state": { "description": "The state of the sender.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "sender_name": { "description": "The name of the funds originator.", "maxLength": 30, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The identifier of the Account Number from which to send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, "required": [ "source_account_number_id", "card_token_id", "presentment_amount", "merchant_city_name", "merchant_state", "merchant_postal_code", "merchant_category_code", "merchant_name", "merchant_name_prefix", "sender_name", "sender_address_line1", "sender_address_city", "sender_address_state", "sender_address_postal_code", "recipient_name", "business_application_identifier" ], "type": "object", "x-event-categories": [] }, "create_a_card_validation_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "card_token_id": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "cardholder_first_name": "Dee", "cardholder_last_name": "Hock", "cardholder_middle_name": "Ward", "cardholder_postal_code": "10045", "cardholder_street_address": "33 Liberty Street", "merchant_category_code": "1234", "merchant_city_name": "New York", "merchant_name": "Acme Corp", "merchant_postal_code": "10045", "merchant_state": "NY" }, "properties": { "account_id": { "description": "The identifier of the Account from which to send the validation.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "card_token_id": { "description": "The Increase identifier for the Card Token that represents the card number you're validating.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" }, "cardholder_first_name": { "description": "The cardholder's first name.", "maxLength": 35, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "cardholder_last_name": { "description": "The cardholder's last name.", "maxLength": 35, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "cardholder_middle_name": { "description": "The cardholder's middle name.", "maxLength": 35, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "cardholder_postal_code": { "description": "The postal code of the cardholder's address.", "maxLength": 9, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "cardholder_street_address": { "description": "The cardholder's street address.", "maxLength": 40, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "A four-digit code (MCC) identifying the type of business or service provided by the merchant.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_city_name": { "description": "The city where the merchant (typically your business) is located.", "maxLength": 13, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The merchant name that will appear in the cardholder’s statement descriptor. Typically your business name.", "maxLength": 25, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The postal code for the merchant’s (typically your business’s) location.", "maxLength": 10, "minLength": 1, "pattern": "^[\\x00-\\x7F]*$", "type": "string", "x-documentation-priority": "default" }, "merchant_state": { "description": "The U.S. state where the merchant (typically your business) is located.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "card_token_id", "merchant_city_name", "merchant_state", "merchant_postal_code", "merchant_category_code", "merchant_name" ], "type": "object", "x-event-categories": [] }, "create_a_check_deposit_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "back_image_file_id": "file_26khfk98mzfz90a11oqx", "description": "Vendor payment", "front_image_file_id": "file_hkv175ovmc2tb2v2zbrm" }, "properties": { "account_id": { "description": "The identifier for the Account to deposit the check in.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The deposit amount in USD cents.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "back_image_file_id": { "description": "The File containing the check's back image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "description": { "description": "The description you choose to give the Check Deposit, for display purposes only.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "front_image_file_id": { "description": "The File containing the check's front image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "account_id", "amount", "front_image_file_id", "back_image_file_id" ], "type": "object", "x-event-categories": [] }, "create_a_check_transfer_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "fulfillment_method": "physical_check", "physical_check": { "mailing_address": { "city": "New York", "line1": "33 Liberty Street", "name": "Ian Crease", "phone": "+16505046304", "postal_code": "10045", "state": "NY" }, "memo": "Check payment", "recipient_name": "Ian Crease", "return_address": null, "signature": { "text": "Ian Crease" } }, "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "valid_until_date": "2025-12-31" }, "properties": { "account_id": { "description": "The identifier for the account that will send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The transfer amount in USD cents.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "balance_check": { "description": "How the account's available balance should be checked. If omitted, the default behavior is `balance_check: full`.", "enum": [ "full", "none" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount. This is the default behavior if `balance_check` is omitted.", "No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created." ] }, "check_number": { "description": "The check number Increase should use for the check. This should not contain leading zeroes and must be unique across the `source_account_number`. If this is omitted, Increase will generate a check number for you.", "maxLength": 10, "minLength": 1, "pattern": "^[1-9]\\d*$", "type": "string", "x-documentation-priority": "default" }, "fulfillment_method": { "description": "Whether Increase will print and mail the check or if you will do it yourself.", "enum": [ "physical_check", "third_party" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase will print and mail a physical check.", "Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount." ] }, "physical_check": { "additionalProperties": true, "description": "Details relating to the physical check that Increase will print and mail. This is required if `fulfillment_method` is equal to `physical_check`. It must not be included if any other `fulfillment_method` is provided.", "properties": { "attachment_file_id": { "description": "The ID of a File to be attached to the check. This must have `purpose: check_attachment`. For details on pricing and restrictions, see https://increase.com/documentation/originating-checks#printing-checks .", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "check_voucher_image_file_id": { "description": "The ID of a File to be used as the check voucher image. This must have `purpose: check_voucher_image`. For details on pricing and restrictions, see https://increase.com/documentation/originating-checks#printing-checks .", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "mailing_address": { "additionalProperties": false, "description": "Details for where Increase will mail the check.", "properties": { "city": { "description": "The city component of the check's destination address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address component of the check's destination address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address component of the check's destination address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "name": { "description": "The name component of the check's destination address. Defaults to the provided `recipient_name` parameter if `name` is not provided.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "The phone number to associate with the check's destination address. The phone number is only used when `shipping_method` is `fedex_overnight` and will be supplied to FedEx to be used in case of delivery issues.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code component of the check's destination address.", "maxLength": 10, "minLength": 1, "pattern": "^[0-9]{5}(?:-?[0-9]{4})?$", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The US state component of the check's destination address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "memo": { "description": "The descriptor that will be printed on the memo field on the check.", "maxLength": 100, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "note": { "description": "The descriptor that will be printed on the letter included with the check.", "maxLength": 1200, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "payer": { "description": "The payer of the check. This will be printed on the top-left portion of the check and defaults to the return address if unspecified. This should be an array of up to 4 elements, each of which represents a line of the payer.", "items": { "additionalProperties": false, "properties": { "contents": { "description": "The contents of the line.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "contents" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "recipient_name": { "description": "The name that will be printed on the check in the 'To:' field.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "return_address": { "additionalProperties": false, "description": "The return address to be printed on the check. If omitted this will default to an Increase-owned address that will mark checks as delivery failed and shred them.", "properties": { "city": { "description": "The city of the return address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the return address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the return address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "name": { "description": "The name of the return address.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "The phone number to associate with the shipper. The phone number is only used when `shipping_method` is `fedex_overnight` and will be supplied to FedEx to be used in case of delivery issues.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code of the return address.", "maxLength": 10, "minLength": 1, "pattern": "^[0-9]{5}(?:-?[0-9]{4})?$", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The US state of the return address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "line1", "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "shipping_method": { "description": "How to ship the check. For details on pricing, timing, and restrictions, see https://increase.com/documentation/originating-checks#printing-checks .", "enum": [ "usps_first_class", "fedex_overnight" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "USPS First Class", "FedEx Overnight" ] }, "signature": { "additionalProperties": false, "description": "The signature that will appear on the check. If not provided, the check will be printed with 'No Signature Required'. At most one of `text` and `image_file_id` may be provided.", "properties": { "image_file_id": { "description": "The ID of a File containing a PNG of the signature. This must have `purpose: check_signature` and be a 1320x120 pixel PNG.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "text": { "description": "The text that will appear as the signature on the check in cursive font.", "maxLength": 30, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "memo", "recipient_name", "mailing_address" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The identifier of the Account Number from which to send the transfer and print on the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "third_party": { "additionalProperties": true, "description": "Details relating to the custom fulfillment you will perform. This is required if `fulfillment_method` is equal to `third_party`. It must not be included if any other `fulfillment_method` is provided.", "properties": { "recipient_name": { "description": "The pay-to name you will print on the check. If provided, this is used for [Positive Pay](/documentation/positive-pay). If this is omitted, Increase will be unable to validate the payer name when the check is deposited.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "valid_until_date": { "description": "If provided, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "source_account_number_id", "fulfillment_method", "amount" ], "type": "object", "x-event-categories": [] }, "create_a_digital_card_profile_parameters": { "additionalProperties": true, "example": { "app_icon_file_id": "file_8zxqkwlh43wo144u8yec", "background_image_file_id": "file_1ai913suu1zfn1pdetru", "card_description": "MyBank Signature Card", "contact_email": "user@example.com", "contact_phone": "+18885551212", "contact_website": "https://example.com", "description": "My Card Profile", "issuer_name": "MyBank", "text_color": { "blue": 59, "green": 43, "red": 26 } }, "properties": { "app_icon_file_id": { "description": "The identifier of the File containing the card's icon image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "background_image_file_id": { "description": "The identifier of the File containing the card's front image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "card_description": { "description": "A user-facing description for the card itself.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "contact_email": { "description": "An email address the user can contact to receive support for their card.", "format": "email", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "contact_phone": { "description": "A phone number the user can contact to receive support for their card.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "contact_website": { "description": "A website the user can visit to view and receive support for their card.", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description you can use to identify the Card Profile.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "issuer_name": { "description": "A user-facing description for whoever is issuing the card.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "text_color": { "additionalProperties": false, "description": "The Card's text color, specified as an RGB triple. The default is white.", "properties": { "blue": { "description": "The value of the blue channel in the RGB color.", "maximum": 255, "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "green": { "description": "The value of the green channel in the RGB color.", "maximum": 255, "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "red": { "description": "The value of the red channel in the RGB color.", "maximum": 255, "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "red", "green", "blue" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "description", "issuer_name", "card_description", "background_image_file_id", "app_icon_file_id" ], "type": "object", "x-event-categories": [] }, "create_a_fednow_transfer_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "creditor_address": { "city": "New York", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "creditor_name": "Ian Crease", "debtor_name": "National Phonograph Company", "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_number": { "description": "The creditor's account number.", "maxLength": 34, "minLength": 1, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The amount, in minor units, to send to the creditor.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "creditor_address": { "additionalProperties": false, "description": "The creditor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 70, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code component of the address.", "maxLength": 10, "minLength": 1, "pattern": "^[0-9]{5}(?:-?[0-9]{4})?$", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The US state component of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "creditor_name": { "description": "The creditor's name.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuüvwxyýz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòó÷øùúûþÿ]*$", "type": "string", "x-documentation-priority": "default" }, "debtor_address": { "additionalProperties": false, "description": "The debtor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 70, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code component of the address.", "maxLength": 10, "minLength": 1, "pattern": "^[0-9]{5}(?:-?[0-9]{4})?$", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The US state component of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "debtor_name": { "description": "The debtor's name.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuüvwxyýz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòó÷øùúûþÿ]*$", "type": "string", "x-documentation-priority": "default" }, "external_account_id": { "description": "The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "routing_number": { "description": "The creditor's bank account routing number.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The Account Number to include in the transfer as the debtor's account number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "unstructured_remittance_information": { "description": "Unstructured remittance information to include in the transfer.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuüvwxyýz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòó÷øùúûþÿ]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "source_account_number_id", "amount", "unstructured_remittance_information", "creditor_name", "debtor_name" ], "type": "object", "x-event-categories": [] }, "create_a_file_link_parameters": { "additionalProperties": true, "example": { "file_id": "file_makxrc67oh9l6sg7w9yc" }, "properties": { "expires_at": { "description": "The time at which the File Link will expire. The default is 1 hour from the time of the request. The maximum is 1 day from the time of the request.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The File to create a File Link for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id" ], "type": "object", "x-event-categories": [] }, "create_a_file_parameters": { "additionalProperties": true, "example": { "file": "\"@tax_form.pdf\"", "purpose": "check_image_front" }, "properties": { "description": { "description": "The description you choose to give the File.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "file": { "description": "The file contents. This should follow the specifications of [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file transfers for the multipart/form-data protocol.", "format": "binary", "type": "string", "x-documentation-priority": "default" }, "purpose": { "description": "What the File will be used for in Increase's systems.", "enum": [ "card_dispute_attachment", "check_image_front", "check_image_back", "mailed_check_image", "check_attachment", "check_voucher_image", "check_signature", "form_ss_4", "identity_document", "loan_application_supplemental_document", "other", "trust_formation_document", "digital_wallet_artwork", "digital_wallet_app_icon", "physical_card_front", "physical_card_carrier", "document_request", "entity_supplemental_document", "unusual_activity_report_attachment", "proof_of_authorization_request_submission" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A file to be attached to a Card Dispute.", "An image of the front of a check, used for check deposits.", "An image of the back of a check, used for check deposits.", "An image of a check that was mailed to a recipient.", "A document to be printed on an additional page and mailed with a check that you've requested Increase print. This must be a PDF whose pages are all US letter size and all have the same orientation.", "An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.", "A signature image to be printed on a check. This must be a 1320x120 pixel PNG.", "IRS Form SS-4.", "An image of a government-issued ID.", "A supplemental document for a Loan Application.", "A file purpose not covered by any of the other cases.", "A legal document forming a trust.", "A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.", "An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.", "A card image to be printed on the front of a physical card. This must be a 2100x1344 pixel PNG with no other color but black.", "An image representing the entirety of the carrier used for a physical card. This must be a 2550x3300 pixel PNG with no other color but black.", "A document requested by Increase.", "A supplemental document associated an an Entity.", "An attachment to an Unusual Activity Report.", "A file containing additional evidence for a Proof of Authorization Request Submission." ] } }, "required": [ "file", "purpose" ], "type": "object", "x-event-categories": [] }, "create_a_lockbox_address_parameters": { "additionalProperties": true, "example": { "description": "Lockbox Address 1" }, "properties": { "description": { "description": "The description you choose for the Lockbox Address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "create_a_lockbox_recipient_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "recipient_name": "Ian Crease" }, "properties": { "account_id": { "description": "The Account that checks sent to this Lockbox Recipient should be deposited into.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "description": { "description": "The description you choose for the Lockbox Recipient.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "lockbox_address_id": { "description": "The Lockbox Address where this Lockbox Recipient may receive mail.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" }, "recipient_name": { "description": "The name of the Lockbox Recipient", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "lockbox_address_id" ], "type": "object", "x-event-categories": [] }, "create_a_notification_of_change_for_an_inbound_ach_transfer_parameters": { "additionalProperties": false, "example": { "updated_account_number": "987654321", "updated_routing_number": "101050001" }, "properties": { "updated_account_number": { "description": "The updated account number to send in the notification of change.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "updated_routing_number": { "description": "The updated routing number to send in the notification of change.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "create_a_pending_transaction_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": -1000, "description": "Hold for pending transaction" }, "properties": { "account_id": { "description": "The Account to place the hold on.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The amount to hold in the minor unit of the account's currency. For dollars, for example, this is cents. This should be a negative amount - to hold $1.00 from the account, you would pass -100.", "maximum": -1, "type": "integer", "x-documentation-priority": "default" }, "description": { "description": "The description you choose to give the hold.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "amount" ], "type": "object", "x-event-categories": [] }, "create_a_physical_card_parameters": { "additionalProperties": true, "example": { "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "first_name": "Ian", "last_name": "Crease" }, "shipment": { "address": { "city": "New York", "line1": "33 Liberty Street", "line2": "Unit 2", "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "method": "usps" } }, "properties": { "card_id": { "description": "The underlying card representing this physical card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "cardholder": { "additionalProperties": false, "description": "Details about the cardholder, as it will appear on the physical card.", "properties": { "first_name": { "description": "The cardholder's first name.", "maxLength": 200, "minLength": 1, "pattern": "^[\\w.\\-/ ]*$", "type": "string", "x-documentation-priority": "default" }, "last_name": { "description": "The cardholder's last name.", "maxLength": 200, "minLength": 1, "pattern": "^[\\w.\\-/ ]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "first_name", "last_name" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "physical_card_profile_id": { "description": "The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Card Profiles" }, "shipment": { "additionalProperties": false, "description": "The details used to ship this physical card.", "properties": { "address": { "additionalProperties": false, "description": "The address to where the card should be shipped.", "properties": { "city": { "description": "The city of the shipping address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-character ISO 3166-1 code of the country where the card should be shipped (e.g., `US`). Please reach out to [support@increase.com](mailto:support@increase.com) to ship cards internationally.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the shipping address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the shipping address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line3": { "description": "The third line of the shipping address.", "maxLength": 9, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "name": { "description": "The name of the recipient.", "maxLength": 35, "minLength": 1, "pattern": "^[\\w.\\-/ ]*$", "type": "string", "x-documentation-priority": "default" }, "phone_number": { "description": "The phone number of the recipient.", "maxLength": 15, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code of the shipping address.", "maxLength": 16, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The state of the shipping address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "line1", "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "The shipping method to use.", "enum": [ "usps", "fedex_priority_overnight", "fedex_2_day", "dhl_worldwide_express" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "USPS Post.", "FedEx Priority Overnight, no signature.", "FedEx 2-day.", "DHL Worldwide Express, international shipping only." ] }, "schedule": { "description": "When this physical card should be produced by the card printer. The default timeline is the day after the card printer receives the order, except for `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster production methods, please reach out to [support@increase.com](mailto:support@increase.com).", "enum": [ "next_day", "same_day" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card will be shipped one business day after the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Wednesday.", "The physical card will be shipped on the same business day that the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Tuesday." ] } }, "required": [ "method", "address" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "card_id", "cardholder", "shipment" ], "type": "object", "x-event-categories": [] }, "create_a_physical_card_profile_parameters": { "additionalProperties": true, "example": { "carrier_image_file_id": "file_h6v7mtipe119os47ehlu", "contact_phone": "+16505046304", "description": "My Card Profile", "front_image_file_id": "file_o6aex13wm1jcc36sgcj1", "program_id": "program_i2v2os4mwza1oetokh9i" }, "properties": { "carrier_image_file_id": { "description": "The identifier of the File containing the physical card's carrier image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "contact_phone": { "description": "A phone number the user can contact to receive support for their card.", "maxLength": 32, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description you can use to identify the Card Profile.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "front_image_file_id": { "description": "The identifier of the File containing the physical card's front image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "front_text": { "additionalProperties": false, "description": "Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.", "properties": { "line1": { "description": "The first line of text on the front of the card.", "maxLength": 33, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of text on the front of the card. Providing a second line moves the first line slightly higher and prints the second line in the spot where the first line would have otherwise been printed.", "maxLength": 33, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "program_id": { "description": "The identifier for the Program that this Physical Card Profile falls under.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" } }, "required": [ "description", "contact_phone", "front_image_file_id", "carrier_image_file_id", "program_id" ], "type": "object", "x-event-categories": [] }, "create_a_real_time_payments_transfer_parameters": { "additionalProperties": true, "example": { "account_number": "987654321", "amount": 100, "creditor_name": "Ian Crease", "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_number": { "description": "The destination account number.", "maxLength": 34, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "creditor_name": { "description": "The name of the transfer's recipient.", "maxLength": 140, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name of the transfer's sender. If not provided, defaults to the name of the account's entity.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuvwxyz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ]*$", "type": "string", "x-documentation-priority": "default" }, "external_account_id": { "description": "The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "routing_number": { "description": "The destination American Bankers' Association (ABA) Routing Transit Number (RTN).", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The identifier of the Account Number from which to send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "ultimate_creditor_name": { "description": "The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuvwxyz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ]*$", "type": "string", "x-documentation-priority": "default" }, "ultimate_debtor_name": { "description": "The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuvwxyz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ]*$", "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Unstructured information that will show on the recipient's bank statement.", "maxLength": 140, "minLength": 1, "pattern": "^[\\ !\"\\#\\$%&'\\(\\)\\*\\+,\\-\\./0123456789:;<=>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_`abcdefghijklmnopqrstuvwxyz\\{\\|\\}~ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "source_account_number_id", "amount", "creditor_name", "unstructured_remittance_information" ], "type": "object", "x-event-categories": [] }, "create_a_supplemental_document_for_an_entity_parameters": { "additionalProperties": true, "example": { "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc" }, "properties": { "entity_id": { "description": "The identifier of the Entity to associate with the supplemental document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "file_id": { "description": "The identifier of the File containing the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "entity_id", "file_id" ], "type": "object", "x-event-categories": [] }, "create_a_swift_transfer_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "bank_identification_code": "ECBFDEFFTPP", "creditor_address": { "city": "Frankfurt", "country": "DE", "line1": "Sonnemannstrasse 20", "postal_code": "60314" }, "creditor_name": "Ian Crease", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "debtor_name": "National Phonograph Company", "instructed_amount": 100, "instructed_currency": "USD", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "unstructured_remittance_information": "New Swift transfer" }, "properties": { "account_id": { "description": "The identifier for the account that will send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The creditor's account number.", "maxLength": 34, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "bank_identification_code": { "description": "The bank identification code (BIC) of the creditor. If it ends with the three-character branch code, this must be 11 characters long. Otherwise this must be 8 characters and the branch code will be assumed to be `XXX`.", "maxLength": 11, "minLength": 1, "pattern": "^(?[A-Z0-9]{4})(?[A-Z0-9]{2})(?[A-Z0-9]{2})(?[A-Z0-9]{3})?$", "type": "string", "x-documentation-priority": "default" }, "creditor_address": { "additionalProperties": false, "description": "The creditor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "maxLength": 2, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 16, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The state, province, or region of the address. Required in certain countries.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "creditor_name": { "description": "The creditor's name.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "debtor_address": { "additionalProperties": false, "description": "The debtor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "maxLength": 2, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 16, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The state, province, or region of the address. Required in certain countries.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "debtor_name": { "description": "The debtor's name.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" }, "instructed_amount": { "description": "The amount, in minor units of `instructed_currency`, to send to the creditor.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "instructed_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the instructed amount.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "United States Dollar" ] }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "routing_number": { "description": "The creditor's bank account routing or transit number. Required in certain countries.", "maxLength": 35, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The Account Number to include in the transfer as the debtor's account number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "unstructured_remittance_information": { "description": "Unstructured remittance information to include in the transfer.", "maxLength": 140, "minLength": 1, "pattern": "^[a-zA-Z0-9/?:().,'+ \\-]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "source_account_number_id", "account_number", "bank_identification_code", "instructed_amount", "instructed_currency", "unstructured_remittance_information", "creditor_name", "creditor_address", "debtor_name", "debtor_address" ], "type": "object", "x-event-categories": [] }, "create_a_wire_drawdown_request_parameters": { "additionalProperties": true, "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 10000, "creditor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "creditor_name": "National Phonograph Company", "debtor_account_number": "987654321", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "debtor_name": "Ian Crease", "debtor_routing_number": "101050001", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_number_id": { "description": "The Account Number to which the debtor should send funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The amount requested from the debtor, in USD cents.", "maximum": 999999999999, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "charge_bearer": { "description": "Determines who bears the cost of the drawdown request. Defaults to `shared` if not specified.", "enum": [ "shared", "debtor", "creditor", "service_level" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Charges are shared between the debtor and creditor.", "Charges are borne by the debtor.", "Charges are borne by the creditor.", "Charges are determined by the service level." ] }, "creditor_address": { "additionalProperties": false, "description": "The creditor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "maxLength": 2, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The ZIP code of the address.", "maxLength": 16, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The address state.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "creditor_name": { "description": "The creditor's name.", "maxLength": 140, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_account_number": { "description": "The debtor's account number.", "maxLength": 34, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "debtor_address": { "additionalProperties": false, "description": "The debtor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "maxLength": 2, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The ZIP code of the address.", "maxLength": 16, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The address state.", "maxLength": 35, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "debtor_external_account_id": { "description": "The ID of an External Account to initiate a transfer to. If this parameter is provided, `debtor_account_number` and `debtor_routing_number` must be absent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" }, "debtor_name": { "description": "The debtor's name.", "maxLength": 140, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The debtor's routing number.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "end_to_end_identification": { "description": "A free-form reference string set by the sender mirrored back in the subsequent wire transfer.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Remittance information the debtor will see as part of the request.", "maxLength": 140, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_number_id", "amount", "unstructured_remittance_information", "debtor_name", "debtor_address", "creditor_name", "creditor_address" ], "type": "object", "x-event-categories": [] }, "create_a_wire_transfer_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "creditor": { "address": { "unstructured": { "line1": "33 Liberty Street", "line2": "New York", "line3": "NY 10045" } }, "name": "Ian Crease" }, "remittance": { "category": "unstructured", "unstructured": { "message": "New account transfer" } }, "routing_number": "101050001" }, "properties": { "account_id": { "description": "The identifier for the account that will send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The account number for the destination account.", "maxLength": 34, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "maximum": 999999999999, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "creditor": { "additionalProperties": false, "description": "The person or business that is receiving the funds from the transfer.", "properties": { "address": { "additionalProperties": false, "description": "The person or business's address.", "properties": { "unstructured": { "additionalProperties": false, "description": "Unstructured address lines.", "properties": { "line1": { "description": "The address line 1.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The address line 2.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "line3": { "description": "The address line 3.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "unstructured" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person or business's name.", "maxLength": 140, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "debtor": { "additionalProperties": false, "description": "The person or business whose funds are being transferred. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.", "properties": { "address": { "additionalProperties": false, "description": "The person or business's address.", "properties": { "unstructured": { "additionalProperties": false, "description": "Unstructured address lines.", "properties": { "line1": { "description": "The address line 1.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The address line 2.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" }, "line3": { "description": "The address line 3.", "maxLength": 35, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "unstructured" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person or business's name.", "maxLength": 140, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "external_account_id": { "description": "The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" }, "inbound_wire_drawdown_request_id": { "description": "The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Drawdown Requests" }, "remittance": { "additionalProperties": false, "description": "Additional remittance information related to the wire transfer.", "properties": { "category": { "description": "The type of remittance information being passed.", "enum": [ "unstructured", "tax" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The wire transfer contains unstructured remittance information.", "The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS)." ] }, "tax": { "additionalProperties": false, "description": "Internal Revenue Service (IRS) tax repayment information. Required if `category` is equal to `tax`.", "properties": { "date": { "description": "The month and year the tax payment is for, in YYYY-MM-DD format. The day is ignored.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification_number": { "description": "The 9-digit Tax Identification Number (TIN) or Employer Identification Number (EIN).", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "type_code": { "description": "The 5-character tax type code.", "maxLength": 5, "minLength": 5, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "date", "type_code", "identification_number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "unstructured": { "additionalProperties": false, "description": "Unstructured remittance information. Required if `category` is equal to `unstructured`.", "properties": { "message": { "description": "The information.", "maxLength": 140, "minLength": 1, "pattern": "^[ a-zA-Z0-9.?!,;:_/@\\\\&'\"`~()<>#%+\\-=$]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "message" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The ID of an Account Number that will be passed to the wire's recipient", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, "required": [ "account_id", "amount", "remittance", "creditor" ], "type": "object", "x-event-categories": [] }, "create_an_account_number_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "name": "Rent payments" }, "properties": { "account_id": { "description": "The Account the Account Number should belong to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "inbound_ach": { "additionalProperties": false, "description": "Options related to how this Account Number should handle inbound ACH transfers.", "properties": { "debit_status": { "description": "Whether ACH debits are allowed against this Account Number. Note that ACH debits will be declined if this is `allowed` but the Account Number is not active. If you do not specify this field, the default is `allowed`.", "enum": [ "allowed", "blocked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "ACH Debits are allowed.", "ACH Debits are blocked." ] } }, "required": [ "debit_status" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "inbound_checks": { "additionalProperties": false, "description": "Options related to how this Account Number should handle inbound check withdrawals.", "properties": { "status": { "description": "How Increase should process checks with this account number printed on them. If you do not specify this field, the default is `check_transfers_only`.", "enum": [ "allowed", "check_transfers_only" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Checks with this Account Number will be processed even if they are not associated with a Check Transfer.", "Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer." ] } }, "required": [ "status" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The name you choose for the Account Number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "name" ], "type": "object", "x-event-categories": [] }, "create_an_account_parameters": { "additionalProperties": true, "example": { "entity_id": "entity_n8y8tnk2p9339ti393yi", "name": "New Account!", "program_id": "program_i2v2os4mwza1oetokh9i" }, "properties": { "entity_id": { "description": "The identifier for the Entity that will own the Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "funding": { "description": "Whether the Account is funded by a loan or by deposits.", "enum": [ "loan", "deposits" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An account funded by a loan. Before opening a loan account, contact support@increase.com to set up a loan program.", "An account funded by deposits." ] }, "informational_entity_id": { "description": "The identifier of an Entity that, while not owning the Account, is associated with its activity. This is generally the beneficiary of the funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "loan": { "additionalProperties": false, "description": "The loan details for the account.", "properties": { "credit_limit": { "description": "The maximum amount of money that can be drawn from the Account.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "grace_period_days": { "description": "The number of days after the statement date that the Account can be past due before being considered delinquent.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "maturity_date": { "description": "The date on which the loan matures.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "statement_day_of_month": { "description": "The day of the month on which the loan statement is generated.", "maximum": 28, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "statement_payment_type": { "description": "The type of statement payment for the account.", "enum": [ "balance", "interest_until_maturity" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The borrower must pay the full balance of the loan at the end of the statement period.", "The borrower must pay the accrued interest at the end of the statement period." ] } }, "required": [ "credit_limit", "grace_period_days", "statement_day_of_month", "statement_payment_type" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The name you choose for the Account.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "program_id": { "description": "The identifier for the Program that this Account falls under. Required if you operate more than one Program.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" } }, "required": [ "name" ], "type": "object", "x-event-categories": [] }, "create_an_account_transfer_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "description": "Creating liquidity", "destination_account_id": "account_uf16sut2ct5bevmq3eh" }, "properties": { "account_id": { "description": "The identifier for the originating Account that will send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "description": { "description": "An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "destination_account_id": { "description": "The identifier for the destination Account that will receive the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "require_approval": { "description": "Whether the transfer should require explicit approval via the dashboard or API. For more information, see [Transfer Approvals](/documentation/transfer-approvals).", "type": "boolean", "x-documentation-priority": "default" } }, "required": [ "account_id", "amount", "description", "destination_account_id" ], "type": "object", "x-event-categories": [] }, "create_an_ach_prenotification_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "routing_number": "101050001" }, "properties": { "account_id": { "description": "The Increase identifier for the account that will send the ACH Prenotification.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The account number for the destination account.", "maxLength": 200, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "addendum": { "description": "Additional information that will be sent to the recipient.", "maxLength": 80, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "company_descriptive_date": { "description": "The description of the date of the ACH Prenotification.", "maxLength": 6, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "company_discretionary_data": { "description": "The data you choose to associate with the ACH Prenotification.", "maxLength": 20, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "company_entry_description": { "description": "The description you wish to be shown to the recipient.", "maxLength": 10, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "company_name": { "description": "The name by which the recipient knows you.", "maxLength": 16, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "credit_debit_indicator": { "description": "Whether the Prenotification is for a future debit or credit.", "enum": [ "credit", "debit" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Prenotification is for an anticipated credit.", "The Prenotification is for an anticipated debit." ] }, "effective_date": { "description": "The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "individual_id": { "description": "Your identifier for the recipient.", "maxLength": 22, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "individual_name": { "description": "The name of therecipient. This value is informational and not verified by the recipient's bank.", "maxLength": 22, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "standard_entry_class_code": { "description": "The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the ACH Prenotification.", "enum": [ "corporate_credit_or_debit", "corporate_trade_exchange", "prearranged_payments_and_deposit", "internet_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Corporate Credit and Debit (CCD) is used for business-to-business payments.", "Corporate Trade Exchange (CTX) allows for including extensive remittance information with business-to-business payments.", "Prearranged Payments and Deposits (PPD) is used for credits or debits originated by an organization to a consumer, such as payroll direct deposits.", "Internet Initiated (WEB) is used for consumer payments initiated or authorized via the Internet. Debits can only be initiated by non-consumers to debit a consumer’s account. Credits can only be used for consumer to consumer transactions." ] } }, "required": [ "account_id", "account_number", "routing_number" ], "type": "object", "x-event-categories": [] }, "create_an_ach_transfer_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "routing_number": "101050001", "statement_descriptor": "New ACH transfer" }, "properties": { "account_id": { "description": "The Increase identifier for the account that will send the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The account number for the destination account.", "maxLength": 17, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "addenda": { "additionalProperties": false, "description": "Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank.", "properties": { "category": { "description": "The type of addenda to pass with the transfer.", "enum": [ "freeform", "payment_order_remittance_advice" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unstructured `payment_related_information` passed through with the transfer.", "Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information." ] }, "freeform": { "additionalProperties": false, "description": "Unstructured `payment_related_information` passed through with the transfer. Required if and only if `category` is `freeform`.", "properties": { "entries": { "description": "Each entry represents an addendum sent with the transfer. In general, you should send at most one addendum–most ACH recipients cannot access beyond the first 80 characters sent. Please reach out to [support@increase.com](mailto:support@increase.com) to send 2 or more addenda to a recipient expecting a specific addendum format.", "items": { "additionalProperties": false, "properties": { "payment_related_information": { "description": "The payment related information passed in the addendum.", "maxLength": 80, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "payment_related_information" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "entries" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "payment_order_remittance_advice": { "additionalProperties": false, "description": "Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information. Required if and only if `category` is `payment_order_remittance_advice`.", "properties": { "invoices": { "description": "ASC X12 RMR records for this specific transfer.", "items": { "additionalProperties": false, "properties": { "invoice_number": { "description": "The invoice number for this reference, determined in advance with the receiver.", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "paid_amount": { "description": "The amount that was paid for this invoice in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "invoice_number", "paid_amount" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "invoices" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "amount": { "description": "The transfer amount in USD cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.", "maximum": 9999999999, "minimum": -9999999999, "type": "integer", "x-documentation-priority": "default" }, "company_descriptive_date": { "description": "The description of the date of the transfer, usually in the format `YYMMDD`. This is included in the transfer data sent to the receiving bank.", "maxLength": 6, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_discretionary_data": { "description": "The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank.", "maxLength": 20, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_entry_description": { "description": "A description of the transfer, included in the transfer data sent to the receiving bank. Standardized formatting may be required, for example `PAYROLL` for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.", "maxLength": 10, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_name": { "description": "The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank.", "maxLength": 16, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "destination_account_holder": { "description": "The type of entity that owns the account to which the ACH Transfer is being sent.", "enum": [ "business", "individual", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is owned by a business.", "The External Account is owned by an individual.", "It's unknown what kind of entity owns the External Account." ] }, "external_account_id": { "description": "The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number`, `routing_number`, and `funding` must be absent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" }, "funding": { "description": "The type of the account to which the transfer will be sent.", "enum": [ "checking", "savings", "general_ledger" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A checking account.", "A savings account.", "A bank's general ledger. Uncommon." ] }, "individual_id": { "description": "Your identifier for the transfer recipient.", "maxLength": 15, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "individual_name": { "description": "The name of the transfer recipient. This value is informational and not verified by the recipient's bank.", "maxLength": 22, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "preferred_effective_date": { "additionalProperties": false, "description": "Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.", "properties": { "date": { "description": "A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to use as the effective date when submitting this transfer.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "settlement_schedule": { "description": "A schedule by which Increase will choose an effective date for the transfer.", "enum": [ "same_day", "future_dated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00.", "The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day." ] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "require_approval": { "description": "Whether the transfer requires explicit approval via the dashboard or API.", "type": "boolean", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "standard_entry_class_code": { "description": "The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the transfer.", "enum": [ "corporate_credit_or_debit", "corporate_trade_exchange", "prearranged_payments_and_deposit", "internet_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Corporate Credit and Debit (CCD) is used for business-to-business payments.", "Corporate Trade Exchange (CTX) allows for including extensive remittance information with business-to-business payments.", "Prearranged Payments and Deposits (PPD) is used for credits or debits originated by an organization to a consumer, such as payroll direct deposits.", "Internet Initiated (WEB) is used for consumer payments initiated or authorized via the Internet. Debits can only be initiated by non-consumers to debit a consumer’s account. Credits can only be used for consumer to consumer transactions." ] }, "statement_descriptor": { "description": "A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If `individual_name` and `company_name` are not explicitly set by this API, the `statement_descriptor` will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass `individual_name` and `company_name` instead of relying on this fallback.", "maxLength": 200, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "transaction_timing": { "description": "The timing of the transaction.", "enum": [ "synchronous", "asynchronous" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A Transaction will be created immediately.", "A Transaction will be created when the funds settle at the Federal Reserve." ] } }, "required": [ "account_id", "amount", "statement_descriptor" ], "type": "object", "x-event-categories": [] }, "create_an_entity_onboarding_session_parameters": { "additionalProperties": true, "example": { "program_id": "program_i2v2os4mwza1oetokh9i", "redirect_url": "https://example.com/onboarding/session" }, "properties": { "entity_id": { "description": "The identifier of an existing Entity to associate with the onboarding session. If provided, the onboarding form will display any outstanding tasks required to complete the Entity's onboarding.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "program_id": { "description": "The identifier of the Program the Entity will be onboarded to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" }, "redirect_url": { "description": "The URL to redirect the customer to after they complete the onboarding form. The redirect will include `entity_onboarding_session_id` and `entity_id` query parameters.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "redirect_url", "program_id" ], "type": "object", "x-event-categories": [] }, "create_an_entity_parameters": { "additionalProperties": true, "example": { "corporation": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "beneficial_owners": [ { "company_title": "CEO", "individual": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number": "078051120" }, "name": "Ian Crease" }, "prongs": [ "control" ] } ], "incorporation_state": "NY", "legal_identifier": { "category": "us_employer_identification_number", "value": "602214076" }, "name": "National Phonograph Company", "website": "https://example.com" }, "structure": "corporation", "supplemental_documents": [ { "file_id": "file_makxrc67oh9l6sg7w9yc" } ] }, "properties": { "corporation": { "additionalProperties": true, "description": "Details of the corporation entity to create. Required if `structure` is equal to `corporation`.", "properties": { "address": { "additionalProperties": false, "description": "The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "beneficial_owners": { "description": "The identifying details of each person who owns 25% or more of the business and one control person, like the CEO, CFO, or other executive. You can submit between 1 and 5 people to this list.", "items": { "additionalProperties": true, "properties": { "company_title": { "description": "This person's role or title within the entity.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "individual": { "additionalProperties": false, "description": "Personal details for the beneficial owner.", "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "prongs": { "description": "Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both.", "items": { "enum": [ "ownership", "control" ], "type": "string", "x-enum-descriptions": [ "A person with 25% or greater direct or indirect ownership of the entity.", "A person who manages, directs, or has significant control of the entity." ] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "individual", "prongs" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "beneficial_ownership_exemption_reason": { "description": "If the entity is exempt from the requirement to submit beneficial owners, provide the justification. If a reason is provided, you do not need to submit a list of beneficial owners.", "enum": [ "regulated_financial_institution", "publicly_traded_company", "public_entity", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regulated financial institution.", "A publicly traded company.", "A public entity acting on behalf of the federal or a state government.", "Any other reason why this entity is exempt from the requirement to submit beneficial owners. You can only use this exemption after approval from your bank partner." ] }, "email": { "description": "An email address for the business. Not every program requires an email for submitted Entities.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "incorporation_state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "industry_code": { "description": "The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like `5132` for `Software Publishers`. A full list of classification codes is available [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "legal_identifier": { "additionalProperties": false, "description": "The legal identifier of the corporation. This is usually the Employer Identification Number (EIN).", "properties": { "category": { "description": "The category of the legal identifier. If not provided, the default is `us_employer_identification_number`.", "enum": [ "us_employer_identification_number", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.", "A legal identifier issued by a foreign government, like a tax identification number or registration number." ] }, "value": { "description": "The legal identifier. For US Employer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "value" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The legal name of the corporation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "website": { "description": "The website of the corporation.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "legal_identifier", "address", "beneficial_owners" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "description": { "description": "The description you choose to give the entity.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "government_authority": { "additionalProperties": false, "description": "Details of the Government Authority entity to create. Required if `structure` is equal to `government_authority`.", "properties": { "address": { "additionalProperties": false, "description": "The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP code of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "zip" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "authorized_persons": { "description": "The identifying details of authorized officials acting on the entity's behalf.", "items": { "additionalProperties": false, "properties": { "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "category": { "description": "The category of the government authority.", "enum": [ "municipality", "state_agency", "state_government", "federal_agency" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A municipality.", "A state agency.", "A state government.", "A federal agency." ] }, "name": { "description": "The legal name of the government authority.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "tax_identifier": { "description": "The Employer Identification Number (EIN) for the government authority. Submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "website": { "description": "The website of the government authority.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "category", "tax_identifier", "address", "authorized_persons" ], "type": "object", "x-documentation-priority": "low", "x-event-categories": [] }, "joint": { "additionalProperties": false, "description": "Details of the joint entity to create. Required if `structure` is equal to `joint`.", "properties": { "individuals": { "description": "The two individuals that share control of the entity.", "items": { "additionalProperties": false, "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "individuals" ], "type": "object", "x-documentation-priority": "low", "x-event-categories": [] }, "natural_person": { "additionalProperties": false, "description": "Details of the natural person entity to create. Required if `structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods.", "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "risk_rating": { "additionalProperties": false, "description": "An assessment of the entity's potential risk of involvement in financial crimes, such as money laundering.", "properties": { "rated_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "rating": { "description": "The rating given to this entity.", "enum": [ "low", "medium", "high" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Minimal risk of involvement in financial crime.", "Moderate risk of involvement in financial crime.", "Elevated risk of involvement in financial crime." ] } }, "required": [ "rating", "rated_at" ], "type": "object", "x-documentation-priority": "low", "x-event-categories": [] }, "structure": { "description": "The type of Entity to create.", "enum": [ "corporation", "natural_person", "joint", "trust", "government_authority" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A corporation.", "An individual person.", "Multiple individual people.", "A trust.", "A government authority." ] }, "supplemental_documents": { "description": "Additional documentation associated with the entity.", "items": { "additionalProperties": false, "properties": { "file_id": { "description": "The identifier of the File containing the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "terms_agreements": { "description": "The terms that the Entity agreed to. Not all programs are required to submit this data.", "items": { "additionalProperties": false, "properties": { "agreed_at": { "description": "The timestamp of when the Entity agreed to the terms.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "ip_address": { "description": "The IP address the Entity accessed reviewed the terms from.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "terms_url": { "description": "The URL of the terms agreement. This link will be provided by your bank partner.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "terms_url", "ip_address", "agreed_at" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "low" }, "third_party_verification": { "additionalProperties": false, "description": "If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.", "properties": { "reference": { "description": "The reference identifier for the third party verification.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "vendor": { "description": "The vendor that was used to perform the verification.", "enum": [ "alloy", "middesk", "oscilar", "persona", "taktile" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Alloy. See https://alloy.com for more information.", "Middesk. See https://middesk.com for more information.", "Oscilar. See https://oscilar.com for more information.", "Persona. See https://withpersona.com for more information.", "Taktile. See https://taktile.com for more information." ] } }, "required": [ "reference", "vendor" ], "type": "object", "x-documentation-priority": "low", "x-event-categories": [] }, "trust": { "additionalProperties": false, "description": "Details of the trust entity to create. Required if `structure` is equal to `trust`.", "properties": { "address": { "additionalProperties": false, "description": "The trust's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP code of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "zip" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "category": { "description": "Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require their own Employer Identification Number. Revocable trusts require information about the individual `grantor` who created the trust.", "enum": [ "revocable", "irrevocable" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The trust is revocable by the grantor.", "The trust cannot be revoked." ] }, "formation_document_file_id": { "description": "The identifier of the File containing the formation document of the trust.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "formation_state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "grantor": { "additionalProperties": false, "description": "The grantor of the trust. Required if `category` is equal to `revocable`.", "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The legal name of the trust.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "tax_identifier": { "description": "The Employer Identification Number (EIN) for the trust. Submit nine digits with no dashes or other separators. Required if `category` is equal to `irrevocable`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "trustees": { "description": "The trustees of the trust.", "items": { "additionalProperties": false, "properties": { "individual": { "additionalProperties": false, "description": "Details of the individual trustee. Within the trustee object, this is required if `structure` is equal to `individual`.", "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The person's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "structure": { "description": "The structure of the trustee.", "enum": [ "individual" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The trustee is an individual." ] } }, "required": [ "structure" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "name", "category", "address", "trustees" ], "type": "object", "x-documentation-priority": "low", "x-event-categories": [] } }, "required": [ "structure" ], "type": "object", "x-event-categories": [] }, "create_an_event_subscription_parameters": { "additionalProperties": true, "example": { "url": "https://website.com/webhooks" }, "properties": { "oauth_connection_id": { "description": "If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "selected_event_categories": { "description": "If specified, this subscription will only receive webhooks for Events with the specified `category`. If specifying a Real-Time Decision event category, only one Event Category can be specified for the Event Subscription.", "items": { "additionalProperties": false, "properties": { "event_category": { "description": "The category of the Event to subscribe to.", "enum": [ "account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "blockchain_address.created", "blockchain_address.updated", "blockchain_offramp_transfer.created", "blockchain_offramp_transfer.updated", "blockchain_onramp_transfer.created", "blockchain_onramp_transfer.updated", "bookkeeping_account.created", "bookkeeping_account.updated", "bookkeeping_entry_set.updated", "card.created", "card.updated", "card_payment.created", "card_payment.updated", "card_purchase_supplement.created", "card_profile.created", "card_profile.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_card_profile.created", "digital_card_profile.updated", "digital_wallet_token.created", "digital_wallet_token.updated", "entity.created", "entity.updated", "event_subscription.created", "event_subscription.updated", "export.created", "export.updated", "external_account.created", "external_account.updated", "fednow_transfer.created", "fednow_transfer.updated", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer.created", "inbound_ach_transfer.updated", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_check_deposit.created", "inbound_check_deposit.updated", "inbound_fednow_transfer.created", "inbound_fednow_transfer.updated", "inbound_mail_item.created", "inbound_mail_item.updated", "inbound_real_time_payments_transfer.created", "inbound_real_time_payments_transfer.updated", "inbound_wire_drawdown_request.created", "inbound_wire_transfer.created", "inbound_wire_transfer.updated", "intrafi_account_enrollment.created", "intrafi_account_enrollment.updated", "intrafi_exclusion.created", "intrafi_exclusion.updated", "lockbox.created", "lockbox.updated", "oauth_connection.created", "oauth_connection.deactivated", "card_push_transfer.created", "card_push_transfer.updated", "card_validation.created", "card_validation.updated", "pending_transaction.created", "pending_transaction.updated", "physical_card.created", "physical_card.updated", "physical_card_profile.created", "physical_card_profile.updated", "physical_check.created", "physical_check.updated", "program.created", "program.updated", "proof_of_authorization_request.created", "proof_of_authorization_request.updated", "real_time_decision.card_authorization_requested", "real_time_decision.card_balance_inquiry_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_decision.card_authentication_requested", "real_time_decision.card_authentication_challenge_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "swift_transfer.created", "swift_transfer.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Occurs whenever an Account is created.", "Occurs whenever an Account is updated.", "Occurs whenever an Account Number is created.", "Occurs whenever an Account Number is updated.", "Occurs whenever an Account Statement is created.", "Occurs whenever an Account Transfer is created.", "Occurs whenever an Account Transfer is updated.", "Occurs whenever an ACH Prenotification is created.", "Occurs whenever an ACH Prenotification is updated.", "Occurs whenever an ACH Transfer is created.", "Occurs whenever an ACH Transfer is updated.", "Occurs whenever a Blockchain Address is created.", "Occurs whenever a Blockchain Address is updated.", "Occurs whenever a Blockchain Off-Ramp Transfer is created.", "Occurs whenever a Blockchain Off-Ramp Transfer is updated.", "Occurs whenever a Blockchain On-Ramp Transfer is created.", "Occurs whenever a Blockchain On-Ramp Transfer is updated.", "Occurs whenever a Bookkeeping Account is created.", "Occurs whenever a Bookkeeping Account is updated.", "Occurs whenever a Bookkeeping Entry Set is created.", "Occurs whenever a Card is created.", "Occurs whenever a Card is updated.", "Occurs whenever a Card Payment is created.", "Occurs whenever a Card Payment is updated.", "Occurs whenever a Card Purchase Supplement is created.", "Occurs whenever a Card Profile is created.", "Occurs whenever a Card Profile is updated.", "Occurs whenever a Card Dispute is created.", "Occurs whenever a Card Dispute is updated.", "Occurs whenever a Check Deposit is created.", "Occurs whenever a Check Deposit is updated.", "Occurs whenever a Check Transfer is created.", "Occurs whenever a Check Transfer is updated.", "Occurs whenever a Declined Transaction is created.", "Occurs whenever a Digital Card Profile is created.", "Occurs whenever a Digital Card Profile is updated.", "Occurs whenever a Digital Wallet Token is created.", "Occurs whenever a Digital Wallet Token is updated.", "Occurs whenever an Entity is created.", "Occurs whenever an Entity is updated.", "Occurs whenever an Event Subscription is created.", "Occurs whenever an Event Subscription is updated.", "Occurs whenever an Export is created.", "Occurs whenever an Export is updated.", "Occurs whenever an External Account is created.", "Occurs whenever an External Account is updated.", "Occurs whenever a FedNow Transfer is created.", "Occurs whenever a FedNow Transfer is updated.", "Occurs whenever a File is created.", "Occurs whenever a Group is updated.", "Increase may send webhooks with this category to see if a webhook endpoint is working properly.", "Occurs whenever an Inbound ACH Transfer is created.", "Occurs whenever an Inbound ACH Transfer is updated.", "Occurs whenever an Inbound ACH Transfer Return is created.", "Occurs whenever an Inbound ACH Transfer Return is updated.", "Occurs whenever an Inbound Check Deposit is created.", "Occurs whenever an Inbound Check Deposit is updated.", "Occurs whenever an Inbound FedNow Transfer is created.", "Occurs whenever an Inbound FedNow Transfer is updated.", "Occurs whenever an Inbound Mail Item is created.", "Occurs whenever an Inbound Mail Item is updated.", "Occurs whenever an Inbound Real-Time Payments Transfer is created.", "Occurs whenever an Inbound Real-Time Payments Transfer is updated.", "Occurs whenever an Inbound Wire Drawdown Request is created.", "Occurs whenever an Inbound Wire Transfer is created.", "Occurs whenever an Inbound Wire Transfer is updated.", "Occurs whenever an IntraFi Account Enrollment is created.", "Occurs whenever an IntraFi Account Enrollment is updated.", "Occurs whenever an IntraFi Exclusion is created.", "Occurs whenever an IntraFi Exclusion is updated.", "Occurs whenever a Lockbox is created.", "Occurs whenever a Lockbox is updated.", "Occurs whenever an OAuth Connection is created.", "Occurs whenever an OAuth Connection is deactivated.", "Occurs whenever a Card Push Transfer is created.", "Occurs whenever a Card Push Transfer is updated.", "Occurs whenever a Card Validation is created.", "Occurs whenever a Card Validation is updated.", "Occurs whenever a Pending Transaction is created.", "Occurs whenever a Pending Transaction is updated.", "Occurs whenever a Physical Card is created.", "Occurs whenever a Physical Card is updated.", "Occurs whenever a Physical Card Profile is created.", "Occurs whenever a Physical Card Profile is updated.", "Occurs whenever a Physical Check is created.", "Occurs whenever a Physical Check is updated.", "Occurs whenever a Program is created.", "Occurs whenever a Program is updated.", "Occurs whenever a Proof of Authorization Request is created.", "Occurs whenever a Proof of Authorization Request is updated.", "Occurs whenever a Real-Time Decision is created in response to a card authorization.", "Occurs whenever a Real-Time Decision is created in response to a card balance inquiry.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication challenges.", "Occurs whenever a Real-Time Payments Transfer is created.", "Occurs whenever a Real-Time Payments Transfer is updated.", "Occurs whenever a Real-Time Payments Request for Payment is created.", "Occurs whenever a Real-Time Payments Request for Payment is updated.", "Occurs whenever a Swift Transfer is created.", "Occurs whenever a Swift Transfer is updated.", "Occurs whenever a Transaction is created.", "Occurs whenever a Wire Drawdown Request is created.", "Occurs whenever a Wire Drawdown Request is updated.", "Occurs whenever a Wire Transfer is created.", "Occurs whenever a Wire Transfer is updated." ] } }, "required": [ "event_category" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "shared_secret": { "description": "The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.", "maxLength": 100, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The status of the event subscription. Defaults to `active` if not specified.", "enum": [ "active", "disabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The subscription is active and Events will be delivered normally.", "The subscription is temporarily disabled and Events will not be delivered." ] }, "url": { "description": "The URL you'd like us to send webhooks to.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "url" ], "type": "object", "x-event-categories": [] }, "create_an_export_parameters": { "additionalProperties": true, "example": { "category": "transaction_csv", "transaction_csv": { "account_id": "account_in71c4amph0vgo2qllky" } }, "properties": { "account_statement_bai2": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `account_statement_bai2`.", "properties": { "account_id": { "description": "The Account to create a BAI2 report for. If not provided, all open accounts will be included.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "effective_date": { "description": "The date to create a BAI2 report for. If not provided, the current date will be used. The timezone is UTC. If the current date is used, the report will include intraday balances, otherwise it will include end-of-day balances for the provided date.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "program_id": { "description": "The Program to create a BAI2 report for. If not provided, all open accounts will be included.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "account_statement_ofx": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `account_statement_ofx`.", "properties": { "account_id": { "description": "The Account to create a statement for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "created_at": { "additionalProperties": true, "description": "Filter transactions by their created date.", "properties": { "before": { "description": "Filter results to transactions created before this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "on_or_after": { "description": "Filter results to transactions created on or after this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "account_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "account_verification_letter": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `account_verification_letter`.", "properties": { "account_number_id": { "description": "The Account Number to create a letter for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "balance_date": { "description": "The date of the balance to include in the letter. Defaults to the current date.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_number_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "bookkeeping_account_balance_csv": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `bookkeeping_account_balance_csv`.", "properties": { "bookkeeping_account_id": { "description": "Filter exported Bookkeeping Account Balances to the specified Bookkeeping Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Bookkeeping Accounts" }, "on_or_after_date": { "description": "Filter exported Balances to those on or after this date.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "on_or_before_date": { "description": "Filter exported Balances to those on or before this date.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "category": { "description": "The type of Export to create.", "enum": [ "account_statement_ofx", "account_statement_bai2", "transaction_csv", "balance_csv", "bookkeeping_account_balance_csv", "entity_csv", "vendor_csv", "account_verification_letter", "funding_instructions", "voided_check", "daily_account_balance_csv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.", "Export a BAI2 file of transactions and balances for a given date and optional Account.", "Export a CSV of all transactions for a given time range.", "Export a CSV of account balances for the dates in a given range.", "Export a CSV of bookkeeping account balances for the dates in a given range.", "Export a CSV of entities with a given status.", "Export a CSV of vendors added to the third-party risk management dashboard.", "A PDF of an account verification letter.", "A PDF of funding instructions.", "A PDF of a voided check.", "Export a CSV of daily account balances with starting and ending balances for a given date range." ] }, "daily_account_balance_csv": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `daily_account_balance_csv`.", "properties": { "account_id": { "description": "Filter exported Balances to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "on_or_after_date": { "description": "Filter exported Balances to those on or after this date.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "on_or_before_date": { "description": "Filter exported Balances to those on or before this date.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "entity_csv": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `entity_csv`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "funding_instructions": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `funding_instructions`.", "properties": { "account_number_id": { "description": "The Account Number to create funding instructions for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, "required": [ "account_number_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "transaction_csv": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `transaction_csv`.", "properties": { "account_id": { "description": "Filter exported Transactions to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "created_at": { "additionalProperties": false, "description": "Filter results by time range on the `created_at` attribute.", "properties": { "after": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "before": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "on_or_after": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "on_or_before": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "vendor_csv": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `vendor_csv`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "voided_check": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `voided_check`.", "properties": { "account_number_id": { "description": "The Account Number for the voided check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "payer": { "description": "The payer information to be printed on the check.", "items": { "additionalProperties": false, "properties": { "line": { "description": "The contents of the line.", "maxLength": 35, "minLength": 1, "pattern": "^[\\u0000-\\uFFFF]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "account_number_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-event-categories": [] }, "create_an_external_account_parameters": { "additionalProperties": true, "example": { "account_holder": "business", "account_number": "987654321", "description": "Landlord", "routing_number": "101050001" }, "properties": { "account_holder": { "description": "The type of entity that owns the External Account.", "enum": [ "business", "individual", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is owned by a business.", "The External Account is owned by an individual.", "It's unknown what kind of entity owns the External Account." ] }, "account_number": { "description": "The account number for the destination account.", "maxLength": 17, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "The name you choose for the Account.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "funding": { "description": "The type of the destination account. Defaults to `checking`.", "enum": [ "checking", "savings", "general_ledger", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A checking account.", "A savings account.", "A general ledger account.", "A different type of account." ] }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "routing_number", "account_number", "description" ], "type": "object", "x-event-categories": [] }, "create_an_intrafi_exclusion_parameters": { "additionalProperties": true, "example": { "entity_id": "entity_n8y8tnk2p9339ti393yi", "fdic_certificate_number": "314159" }, "properties": { "entity_id": { "description": "The identifier of the Entity whose deposits will be excluded.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "fdic_certificate_number": { "description": "The FDIC certificate number of the financial institution to be excluded. An FDIC certificate number uniquely identifies a financial institution, and is different than a routing number. To find one, we recommend searching by Bank Name using the [FDIC's bankfind tool](https://banks.data.fdic.gov/bankfind-suite/bankfind).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "entity_id", "fdic_certificate_number" ], "type": "object", "x-event-categories": [] }, "create_an_oauth_token_parameters": { "additionalProperties": true, "example": { "client_id": "12345", "client_secret": "supersecret", "code": "123", "grant_type": "authorization_code" }, "properties": { "client_id": { "description": "The public identifier for your application.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "client_secret": { "description": "The secret that confirms you own the application. This is redundant given that the request is made with your API key but it's a required component of OAuth 2.0.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "code": { "description": "The authorization code generated by the user and given to you as a query parameter.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "grant_type": { "description": "The credential you request in exchange for the code. In Production, this is always `authorization_code`. In Sandbox, you can pass either enum value.", "enum": [ "authorization_code", "production_token" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An OAuth authorization code.", "An OAuth production token." ] }, "production_token": { "description": "The production token you want to exchange for a sandbox token. This is only available in Sandbox. Set `grant_type` to `production_token` to use this parameter.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "grant_type" ], "type": "object", "x-event-categories": [] }, "decline_an_inbound_ach_transfer_parameters": { "additionalProperties": false, "example": { "reason": "payment_stopped" }, "properties": { "reason": { "description": "The reason why this transfer will be returned. If this parameter is unset, the return codes will be `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.", "enum": [ "insufficient_funds", "authorization_revoked_by_customer", "payment_stopped", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "beneficiary_or_account_holder_deceased", "credit_entry_refused_by_receiver", "duplicate_entry", "corporate_customer_advised_not_authorized" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01.", "The customer no longer authorizes this transaction. The Nacha return code is R07.", "The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.", "The customer advises that the debit was unauthorized. The Nacha return code is R10.", "The payee is deceased. The Nacha return code is R14.", "The account holder is deceased. The Nacha return code is R15.", "The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.", "The account holder identified this transaction as a duplicate. The Nacha return code is R24.", "The corporate customer no longer authorizes this transaction. The Nacha return code is R29." ] } }, "type": "object", "x-event-categories": [] }, "declined_transaction": { "additionalProperties": true, "description": "Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1750, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "ach_decline": { "amount": 1750, "id": "ach_decline_72v1mcwxudctq56efipa", "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "reason": "insufficient_funds", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "type": "ach_decline" }, "category": "ach_decline" }, "type": "declined_transaction" }, "properties": { "account_id": { "description": "The identifier for the Account the Declined Transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occurred.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "description": { "description": "This is the description the vendor provides.", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Declined Transaction identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "route_id": { "description": "The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "route_type": { "description": "The type of the route this Declined Transaction came through.", "enum": [ "account_number", "card", "lockbox" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An Account Number.", "A Card.", "A Lockbox." ], "nullable": true }, "source": { "additionalProperties": true, "description": "This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.", "example": { "ach_decline": { "amount": 1750, "id": "ach_decline_72v1mcwxudctq56efipa", "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "reason": "insufficient_funds", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "type": "ach_decline" }, "category": "ach_decline" }, "properties": { "ach_decline": { "description": "An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/ach_decline" } ], "nullable": true }, "card_decline": { "additionalProperties": true, "description": "A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.", "example": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": -1000, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "declined_transaction_id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "digital_wallet_token_id": null, "direction": "settlement", "id": "card_decline_bx3o8zd7glq8yvtwg25v", "incremented_card_authorization_id": null, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": null, "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "physical_card_id": null, "presentment_amount": -1000, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "real_time_decision_reason": null, "reason": "insufficient_funds", "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "properties": { "actioner": { "description": "Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.", "enum": [ "user", "increase", "network" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This object was actioned by the user through a real-time decision.", "This object was actioned by Increase without user intervention.", "This object was actioned by the network, through stand-in processing." ] }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "amount": { "description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "declined_transaction_id": { "description": "The identifier of the declined transaction created for this Card Decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "direction": { "description": "The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.", "enum": [ "settlement", "refund" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regular card authorization where funds are debited from the cardholder.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder." ] }, "id": { "description": "The Card Decline identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Declines" }, "incremented_card_authorization_id": { "description": "The identifier of the card authorization this request attempted to incrementally authorize.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations", "nullable": true }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Declined Transaction Declined Transaction Source Card Decline NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Declined Transaction Declined Transaction Source Card Decline NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Declined Transaction Declined Transaction Source Card Decline NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Declined Transaction Declined Transaction Source Card Decline NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "presentment_amount": { "description": "The declined amount in the minor unit of the transaction's presentment currency.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.", "type": "string", "x-documentation-priority": "default" }, "processing_category": { "description": "The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.", "enum": [ "account_funding", "automatic_fuel_dispenser", "bill_payment", "original_credit", "purchase", "quasi_cash", "refund", "cash_disbursement", "balance_inquiry", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.", "Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.", "A transaction used to pay a bill.", "Original credit transactions are used to send money to a cardholder.", "A regular purchase.", "Quasi-cash transactions represent purchases of items which may be convertible to cash.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.", "Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.", "A balance inquiry transaction is used to check the balance of an account associated with a card.", "The processing category is unknown." ] }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "real_time_decision_reason": { "description": "This is present if a specific decline reason was given in the real-time decision.", "enum": [ "insufficient_funds", "transaction_never_allowed", "exceeds_approval_limit", "card_temporarily_disabled", "suspected_fraud", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again.", "This type of transaction is not allowed for this card. This transaction should not be retried.", "The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again.", "The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again.", "The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.", "The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly." ], "nullable": true }, "reason": { "description": "Why the transaction was declined.", "enum": [ "account_closed", "card_not_active", "card_canceled", "physical_card_not_active", "entity_not_active", "group_locked", "insufficient_funds", "cvv2_mismatch", "pin_mismatch", "card_expiration_mismatch", "transaction_not_allowed", "breaches_limit", "webhook_declined", "webhook_timed_out", "declined_by_stand_in_processing", "invalid_physical_card", "missing_original_authorization", "invalid_cryptogram", "failed_3ds_authentication", "suspected_card_testing", "suspected_fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account has been closed.", "The Card was not active.", "The Card has been canceled.", "The Physical Card was not active.", "The account's entity was not active.", "The account was inactive.", "The Card's Account did not have a sufficient available balance.", "The given CVV2 did not match the card's value.", "The given PIN did not match the card's value.", "The given expiration date did not match the card's value. Only applies when a CVV2 is present.", "The attempted card transaction is not allowed per Increase's terms.", "The transaction was blocked by a Limit.", "Your application declined the transaction via webhook.", "Your application webhook did not respond without the required timeout.", "Declined by stand-in processing.", "The card read had an invalid CVV or dCVV.", "The original card authorization for this incremental authorization does not exist.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The transaction was declined because the 3DS authentication failed.", "The transaction was suspected to be used by a card tester to test for valid card numbers.", "The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information." ] }, "scheme_fees": { "description": "The scheme fees associated with this card decline.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Declined Transaction Declined Transaction Source Card Decline Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Declined Transaction Declined Transaction Source Card Decline Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Declined Transaction Declined Transaction Source Card Decline Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Declined Transaction Declined Transaction Source Card Decline Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Declined Transaction Declined Transaction Source Card Decline Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "id", "card_payment_id", "amount", "presentment_amount", "presentment_currency", "currency", "processing_category", "reason", "real_time_decision_reason", "incremented_card_authorization_id", "actioner", "direction", "real_time_decision_id", "scheme_fees", "declined_transaction_id" ], "title": "Declined Transaction Declined Transaction Source Card Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Declines", "nullable": true }, "category": { "description": "The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "ach_decline", "card_decline", "check_decline", "inbound_real_time_payments_transfer_decline", "inbound_fednow_transfer_decline", "wire_decline", "check_deposit_rejection", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "ACH Decline: details will be under the `ach_decline` object.", "Card Decline: details will be under the `card_decline` object.", "Check Decline: details will be under the `check_decline` object.", "Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.", "Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.", "Wire Decline: details will be under the `wire_decline` object.", "Check Deposit Rejection: details will be under the `check_deposit_rejection` object.", "The Declined Transaction was made for an undocumented or deprecated reason." ] }, "check_decline": { "additionalProperties": true, "description": "A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.", "example": { "amount": -1000, "auxiliary_on_us": "99999", "back_image_file_id": null, "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "front_image_file_id": null, "inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "reason": "insufficient_funds" }, "properties": { "amount": { "description": "The declined amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "auxiliary_on_us": { "description": "A computer-readable number printed on the MICR line of business checks, usually the check number. This is useful for positive pay checks, but can be unreliably transmitted by the bank of first deposit.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "back_image_file_id": { "description": "The identifier of the API File object containing an image of the back of the declined check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "check_transfer_id": { "description": "The identifier of the Check Transfer object associated with this decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers", "nullable": true }, "front_image_file_id": { "description": "The identifier of the API File object containing an image of the front of the declined check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "inbound_check_deposit_id": { "description": "The identifier of the Inbound Check Deposit object associated with this decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits", "nullable": true }, "reason": { "description": "Why the check was declined.", "enum": [ "ach_route_disabled", "ach_route_canceled", "altered_or_fictitious", "breaches_limit", "endorsement_irregular", "entity_not_active", "group_locked", "insufficient_funds", "stop_payment_requested", "duplicate_presentment", "not_authorized", "amount_mismatch", "not_our_item", "no_account_number_found", "refer_to_image", "unable_to_process", "unusable_image", "user_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is disabled.", "The account number is canceled.", "The deposited check was altered or fictitious.", "The transaction would cause a limit to be exceeded.", "The check was not endorsed by the payee.", "The account's entity is not active.", "Your account is inactive.", "Your account contains insufficient funds.", "Stop payment requested for this check.", "The check was a duplicate deposit.", "The check was not authorized.", "The amount the receiving bank is attempting to deposit does not match the amount on the check.", "The check attempting to be deposited does not belong to Increase.", "The account number on the check does not exist at Increase.", "The check is not readable. Please refer to the image.", "The check cannot be processed. This is rare: please contact support.", "The check image is unusable.", "Your integration declined this check via the API." ] } }, "required": [ "amount", "auxiliary_on_us", "reason", "front_image_file_id", "back_image_file_id", "inbound_check_deposit_id", "check_transfer_id" ], "title": "Declined Transaction Declined Transaction Source Check Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Declines", "nullable": true }, "check_deposit_rejection": { "additionalProperties": true, "description": "A Check Deposit Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_rejection`.", "example": { "amount": 1750, "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "declined_transaction_id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "reason": "incomplete_image", "rejected_at": "2020-01-31T23:59:59Z" }, "properties": { "amount": { "description": "The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "check_deposit_id": { "description": "The identifier of the Check Deposit that was rejected.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "declined_transaction_id": { "description": "The identifier of the associated declined transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "reason": { "description": "Why the check deposit was rejected.", "enum": [ "incomplete_image", "duplicate", "poor_image_quality", "incorrect_amount", "incorrect_recipient", "not_eligible_for_mobile_deposit", "missing_required_data_elements", "suspected_fraud", "deposit_window_expired", "requested_by_user", "international", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check's image is incomplete.", "This is a duplicate check submission.", "This check has poor image quality.", "The check was deposited with the incorrect amount.", "The check is made out to someone other than the account holder.", "This check was not eligible for mobile deposit.", "This check is missing at least one required field.", "This check is suspected to be fraudulent.", "This check's deposit window has expired.", "The check was rejected at the user's request.", "The check is not a U.S. domestic check and cannot be processed.", "The check was rejected for an unknown reason." ] }, "rejected_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "check_deposit_id", "declined_transaction_id", "amount", "currency", "reason", "rejected_at" ], "title": "Declined Transaction Declined Transaction Source Check Deposit Rejection", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Rejections", "nullable": true }, "inbound_fednow_transfer_decline": { "additionalProperties": true, "description": "An Inbound FedNow Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_fednow_transfer_decline`.", "example": { "reason": "account_number_disabled", "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "properties": { "reason": { "description": "Why the transfer was declined.", "enum": [ "account_number_canceled", "account_number_disabled", "account_restricted", "group_locked", "entity_not_active", "fednow_not_enabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "Your account is restricted.", "Your account is inactive.", "The account's entity is not active.", "Your account is not enabled to receive FedNow transfers." ] }, "transfer_id": { "description": "The identifier of the FedNow Transfer that led to this declined transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound FedNow Transfers" } }, "required": [ "reason", "transfer_id" ], "title": "Declined Transaction Declined Transaction Source Inbound FedNow Transfer Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound FedNow Transfer Declines", "nullable": true }, "inbound_real_time_payments_transfer_decline": { "additionalProperties": true, "description": "An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.", "example": { "amount": 100, "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "reason": "account_number_disabled", "transaction_identification": "20220501234567891T1BSLZO01745013025", "transfer_id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "amount": { "description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "creditor_name": { "description": "The name the sender of the transfer specified as the recipient of the transfer.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be \"USD\" for a Real-Time Payments transfer.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor_account_number": { "description": "The account number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name provided by the sender of the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The routing number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Why the transfer was declined.", "enum": [ "account_number_canceled", "account_number_disabled", "account_restricted", "group_locked", "entity_not_active", "real_time_payments_not_enabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "Your account is restricted.", "Your account is inactive.", "The account's entity is not active.", "Your account is not enabled to receive Real-Time Payments transfers." ] }, "transaction_identification": { "description": "The Real-Time Payments network identification of the declined transfer.", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Real-Time Payments Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Real-Time Payments Transfers" }, "unstructured_remittance_information": { "description": "Additional information included with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "amount", "currency", "reason", "creditor_name", "debtor_name", "debtor_account_number", "debtor_routing_number", "transaction_identification", "unstructured_remittance_information", "transfer_id" ], "title": "Declined Transaction Declined Transaction Source Inbound Real-Time Payments Transfer Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound Real-Time Payments Transfer Declines", "nullable": true }, "other": { "additionalProperties": false, "description": "If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null.", "properties": {}, "title": "Declined Transaction Declined Transaction Source Other", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Others", "nullable": true }, "wire_decline": { "additionalProperties": true, "description": "A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`.", "example": { "inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "reason": "account_number_disabled" }, "properties": { "inbound_wire_transfer_id": { "description": "The identifier of the Inbound Wire Transfer that was declined.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers" }, "reason": { "description": "Why the wire transfer was declined.", "enum": [ "account_number_canceled", "account_number_disabled", "entity_not_active", "group_locked", "no_account_number", "transaction_not_allowed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "The account's entity is not active.", "Your account is inactive.", "The beneficiary account number does not exist.", "The transaction is not allowed per Increase's terms." ] } }, "required": [ "reason", "inbound_wire_transfer_id" ], "title": "Declined Transaction Declined Transaction Source Wire Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Wire Declines", "nullable": true } }, "required": [ "category" ], "title": "Declined Transaction Declined Transaction Source", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Declined Transaction Sources" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `declined_transaction`.", "enum": [ "declined_transaction" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "amount", "currency", "created_at", "description", "id", "route_id", "route_type", "source" ], "title": "Declined Transaction", "type": "object", "x-event-categories": [ "declined_transaction.created" ], "x-tag": "Declined Transactions", "x-title-plural": "Declined Transactions" }, "declined_transaction_list": { "additionalProperties": true, "description": "A list of Declined Transaction objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1750, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "ach_decline": { "amount": 1750, "id": "ach_decline_72v1mcwxudctq56efipa", "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "reason": "insufficient_funds", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "type": "ach_decline" }, "category": "ach_decline" }, "type": "declined_transaction" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/declined_transaction" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Declined Transaction List", "type": "object", "x-event-categories": [], "x-title-plural": "Declined Transaction Lists" }, "digital_card_profile": { "additionalProperties": true, "description": "This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on [digital card artwork](https://increase.com/documentation/card-art).", "example": { "app_icon_file_id": "file_makxrc67oh9l6sg7w9yc", "background_image_file_id": "file_makxrc67oh9l6sg7w9yc", "card_description": "Black Card", "contact_email": "user@example.com", "contact_phone": "+18882988865", "contact_website": "https://example.com", "created_at": "2020-01-31T23:59:59Z", "description": "Corporate logo Apple Pay Card", "id": "digital_card_profile_s3puplu90f04xhcwkiga", "idempotency_key": null, "issuer_name": "National Phonograph Company", "status": "active", "text_color": { "blue": 230, "green": 255, "red": 189 }, "type": "digital_card_profile" }, "properties": { "app_icon_file_id": { "description": "The identifier of the File containing the card's icon image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "background_image_file_id": { "description": "The identifier of the File containing the card's front image.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "card_description": { "description": "A user-facing description for the card itself.", "type": "string", "x-documentation-priority": "default" }, "contact_email": { "description": "An email address the user can contact to receive support for their card.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "contact_phone": { "description": "A phone number the user can contact to receive support for their card.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "contact_website": { "description": "A website the user can visit to view and receive support for their card.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Digital Card Profile was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description you can use to identify the Card Profile.", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Card Profile identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "issuer_name": { "description": "A user-facing description for whoever is issuing the card.", "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The status of the Card Profile.", "enum": [ "pending", "rejected", "active", "archived" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Card Profile is awaiting review from Increase and/or processing by card networks.", "There is an issue with the Card Profile preventing it from use.", "The Card Profile can be assigned to Cards.", "The Card Profile is no longer in use." ] }, "text_color": { "additionalProperties": false, "description": "The Card's text color, specified as an RGB triple.", "properties": { "blue": { "description": "The value of the blue channel in the RGB color.", "type": "integer", "x-documentation-priority": "default" }, "green": { "description": "The value of the green channel in the RGB color.", "type": "integer", "x-documentation-priority": "default" }, "red": { "description": "The value of the red channel in the RGB color.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "red", "green", "blue" ], "title": "Digital Card Profile TextColor", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "TextColors" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `digital_card_profile`.", "enum": [ "digital_card_profile" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "status", "description", "text_color", "issuer_name", "card_description", "contact_website", "contact_email", "contact_phone", "background_image_file_id", "app_icon_file_id", "idempotency_key" ], "title": "Digital Card Profile", "type": "object", "x-event-categories": [ "digital_card_profile.created", "digital_card_profile.updated" ], "x-tag": "Digital Card Profiles", "x-title-plural": "Digital Card Profiles" }, "digital_card_profile_list": { "additionalProperties": true, "description": "A list of Digital Card Profile objects.", "example": { "data": [ { "app_icon_file_id": "file_makxrc67oh9l6sg7w9yc", "background_image_file_id": "file_makxrc67oh9l6sg7w9yc", "card_description": "Black Card", "contact_email": "user@example.com", "contact_phone": "+18882988865", "contact_website": "https://example.com", "created_at": "2020-01-31T23:59:59Z", "description": "Corporate logo Apple Pay Card", "id": "digital_card_profile_s3puplu90f04xhcwkiga", "idempotency_key": null, "issuer_name": "National Phonograph Company", "status": "active", "text_color": { "blue": 230, "green": 255, "red": 189 }, "type": "digital_card_profile" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/digital_card_profile" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Digital Card Profile List", "type": "object", "x-event-categories": [], "x-title-plural": "Digital Card Profile Lists" }, "digital_wallet_token": { "additionalProperties": false, "description": "A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.", "example": { "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "name": "John Smith" }, "created_at": "2020-01-31T23:59:59Z", "device": { "device_type": "mobile_phone", "identifier": "04393EADF4149002225811273840459271E36516DA4875FF", "ip_address": "1.2.3.4", "name": "My Work Phone" }, "dynamic_primary_account_number": null, "id": "digital_wallet_token_izi62go3h51p369jrie0", "status": "active", "token_requestor": "apple_pay", "type": "digital_wallet_token", "updates": [ { "status": "inactive", "timestamp": "2020-01-31T23:59:59Z" } ] }, "properties": { "card_id": { "description": "The identifier for the Card this Digital Wallet Token belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "cardholder": { "additionalProperties": false, "description": "The cardholder information given when the Digital Wallet Token was created.", "properties": { "name": { "description": "Name of the cardholder, for example \"John Smith\".", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name" ], "title": "Digital Wallet Token Cardholder", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholders" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Digital Wallet Token was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "device": { "additionalProperties": false, "description": "The device that was used to create the Digital Wallet Token.", "properties": { "device_type": { "description": "Device type.", "enum": [ "unknown", "mobile_phone", "tablet", "watch", "mobilephone_or_tablet", "pc", "household_device", "wearable_device", "automobile_device" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Mobile Phone", "Tablet", "Watch", "Mobile Phone or Tablet", "PC", "Household Device", "Wearable Device", "Automobile Device" ], "nullable": true }, "identifier": { "description": "ID assigned to the device by the digital wallet provider.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "ip_address": { "description": "IP address of the device.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "name": { "description": "Name of the device, for example \"My Work Phone\".", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "device_type", "identifier", "ip_address", "name" ], "title": "Digital Wallet Token Device", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Devices" }, "dynamic_primary_account_number": { "additionalProperties": false, "description": "The redacted Dynamic Primary Account Number.", "properties": { "first6": { "description": "The first 6 digits of the token's Dynamic Primary Account Number.", "type": "string", "x-documentation-priority": "default" }, "last4": { "description": "The last 4 digits of the token's Dynamic Primary Account Number.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "first6", "last4" ], "title": "Digital Wallet Token DynamicPrimaryAccountNumber", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "DynamicPrimaryAccountNumbers", "nullable": true }, "id": { "description": "The Digital Wallet Token identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens" }, "status": { "description": "This indicates if payments can be made with the Digital Wallet Token.", "enum": [ "active", "inactive", "suspended", "deactivated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The digital wallet token is active.", "The digital wallet token has been created but not successfully activated via two-factor authentication yet.", "The digital wallet token has been temporarily paused.", "The digital wallet token has been permanently canceled." ] }, "token_requestor": { "description": "The digital wallet app being used.", "enum": [ "apple_pay", "google_pay", "samsung_pay", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Apple Pay", "Google Pay", "Samsung Pay", "Unknown" ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `digital_wallet_token`.", "enum": [ "digital_wallet_token" ], "type": "string", "x-documentation-priority": "default" }, "updates": { "description": "Updates to the Digital Wallet Token.", "items": { "additionalProperties": false, "properties": { "status": { "description": "The status the update changed this Digital Wallet Token to.", "enum": [ "active", "inactive", "suspended", "deactivated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The digital wallet token is active.", "The digital wallet token has been created but not successfully activated via two-factor authentication yet.", "The digital wallet token has been temporarily paused.", "The digital wallet token has been permanently canceled." ] }, "timestamp": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the update happened.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "timestamp", "status" ], "title": "Digital Wallet Token UpdatesElement", "type": "object", "x-event-categories": [], "x-title-plural": "UpdatesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "type", "id", "card_id", "created_at", "status", "token_requestor", "dynamic_primary_account_number", "cardholder", "device", "updates" ], "title": "Digital Wallet Token", "type": "object", "x-event-categories": [ "digital_wallet_token.created", "digital_wallet_token.updated" ], "x-tag": "Digital Wallet Tokens", "x-title-plural": "Digital Wallet Tokens" }, "digital_wallet_token_list": { "additionalProperties": true, "description": "A list of Digital Wallet Token objects.", "example": { "data": [ { "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "name": "John Smith" }, "created_at": "2020-01-31T23:59:59Z", "device": { "device_type": "mobile_phone", "identifier": "04393EADF4149002225811273840459271E36516DA4875FF", "ip_address": "1.2.3.4", "name": "My Work Phone" }, "dynamic_primary_account_number": null, "id": "digital_wallet_token_izi62go3h51p369jrie0", "status": "active", "token_requestor": "apple_pay", "type": "digital_wallet_token", "updates": [ { "status": "inactive", "timestamp": "2020-01-31T23:59:59Z" } ] } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/digital_wallet_token" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Digital Wallet Token List", "type": "object", "x-event-categories": [], "x-title-plural": "Digital Wallet Token Lists" }, "enroll_an_account_in_the_intrafi_deposit_sweep_network_parameters": { "additionalProperties": true, "example": { "account_id": "account_in71c4amph0vgo2qllky", "email_address": "user@example.com" }, "properties": { "account_id": { "description": "The identifier for the account to be added to IntraFi.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "email_address": { "description": "The contact email for the account owner, to be shared with IntraFi.", "format": "email", "maxLength": 50, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "email_address" ], "type": "object", "x-event-categories": [] }, "entity": { "additionalProperties": true, "description": "Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities).", "example": { "corporation": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "beneficial_owners": [ { "company_title": "CEO", "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "individual": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number_last4": "1120" }, "name": "Ian Crease" }, "prongs": [ "control", "ownership" ] } ], "email": null, "incorporation_state": "NY", "industry_code": null, "legal_identifier": { "category": "us_employer_identification_number", "value": "602214076" }, "name": "National Phonograph Company", "website": "https://example.com" }, "created_at": "2020-01-31T23:59:59Z", "creating_entity_onboarding_session_id": null, "description": null, "details_confirmed_at": null, "government_authority": null, "id": "entity_n8y8tnk2p9339ti393yi", "idempotency_key": null, "joint": null, "natural_person": null, "risk_rating": null, "status": "active", "structure": "corporation", "supplemental_documents": [ { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "type": "entity_supplemental_document" } ], "terms_agreements": [ { "agreed_at": "2020-01-31T23:59:59Z", "ip_address": "128.32.0.1", "terms_url": "https://increase.com/example_terms" } ], "third_party_verification": null, "trust": null, "type": "entity", "validation": null }, "properties": { "corporation": { "additionalProperties": true, "description": "Details of the corporation entity. Will be present if `structure` is equal to `corporation`.", "properties": { "address": { "additionalProperties": false, "description": "The corporation's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Corporation Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "beneficial_owners": { "description": "The identifying details of anyone controlling or owning 25% or more of the corporation.", "items": { "additionalProperties": true, "example": { "company_title": "CEO", "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "individual": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number_last4": "1120" }, "name": "Ian Crease" }, "prongs": [ "control", "ownership" ] }, "properties": { "company_title": { "description": "This person's role or title within the entity.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The identifier of this beneficial owner.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" }, "individual": { "additionalProperties": false, "description": "Personal details for the beneficial owner.", "properties": { "address": { "additionalProperties": false, "description": "The person's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Corporation Beneficial Owner Reference Individual Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number_last4": { "description": "The last 4 digits of the identification number that can be used to verify the individual's identity.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "method", "number_last4" ], "title": "Entity Corporation Beneficial Owner Reference Individual Identification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Identifications", "nullable": true }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "title": "Entity Corporation Beneficial Owner Reference Individual", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Individuals" }, "prongs": { "description": "Why this person is considered a beneficial owner of the entity.", "items": { "enum": [ "ownership", "control" ], "type": "string", "x-enum-descriptions": [ "A person with 25% or greater direct or indirect ownership of the entity.", "A person who manages, directs, or has significant control of the entity." ] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "id", "individual", "company_title", "prongs" ], "title": "Entity Corporation Beneficial Owner Reference", "type": "object", "x-event-categories": [], "x-title-plural": "Beneficial Owner References" }, "type": "array", "x-documentation-priority": "default" }, "email": { "description": "An email address for the business.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "incorporation_state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "industry_code": { "description": "The numeric North American Industry Classification System (NAICS) code submitted for the corporation.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "legal_identifier": { "additionalProperties": false, "description": "The legal identifier of the corporation.", "properties": { "category": { "description": "The category of the legal identifier.", "enum": [ "us_employer_identification_number", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.", "A legal identifier issued by a foreign government, like a tax identification number or registration number." ] }, "value": { "description": "The identifier of the legal identifier.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "category", "value" ], "title": "Entity Corporation LegalIdentifier", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "LegalIdentifiers", "nullable": true }, "name": { "description": "The legal name of the corporation.", "type": "string", "x-documentation-priority": "default" }, "website": { "description": "The website of the corporation.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name", "website", "email", "legal_identifier", "incorporation_state", "industry_code", "address", "beneficial_owners" ], "title": "Entity Corporation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Corporations", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creating_entity_onboarding_session_id": { "description": "The identifier of the Entity Onboarding Session that was used to create this Entity, if any.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entity Onboarding Sessions", "nullable": true }, "description": { "description": "The entity's description for display purposes.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "details_confirmed_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity's details were most recently confirmed.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "government_authority": { "additionalProperties": false, "description": "Details of the government authority entity. Will be present if `structure` is equal to `government_authority`.", "properties": { "address": { "additionalProperties": false, "description": "The government authority's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity GovernmentAuthority Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "authorized_persons": { "description": "The identifying details of authorized persons of the government authority.", "items": { "additionalProperties": false, "properties": { "authorized_person_id": { "description": "The identifier of this authorized person.", "type": "string", "x-documentation-priority": "default" }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "authorized_person_id" ], "title": "Entity GovernmentAuthority AuthorizedPersonsElement", "type": "object", "x-event-categories": [], "x-title-plural": "AuthorizedPersonsElements" }, "type": "array", "x-documentation-priority": "default" }, "category": { "description": "The category of the government authority.", "enum": [ "municipality", "state_agency", "state_government", "federal_agency" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A municipality.", "A state agency.", "A state government.", "A federal agency." ] }, "name": { "description": "The government authority's name.", "type": "string", "x-documentation-priority": "default" }, "tax_identifier": { "description": "The Employer Identification Number (EIN) of the government authority.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "website": { "description": "The government authority's website.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name", "category", "address", "website", "tax_identifier", "authorized_persons" ], "title": "Entity GovernmentAuthority", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "GovernmentAuthorities", "nullable": true }, "id": { "description": "The entity's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "joint": { "additionalProperties": false, "description": "Details of the joint entity. Will be present if `structure` is equal to `joint`.", "properties": { "individuals": { "description": "The two individuals that share control of the entity.", "items": { "additionalProperties": false, "properties": { "address": { "additionalProperties": false, "description": "The person's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Joint Individual Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number_last4": { "description": "The last 4 digits of the identification number that can be used to verify the individual's identity.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "method", "number_last4" ], "title": "Entity Joint Individual Identification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Identifications", "nullable": true }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "title": "Entity Joint Individual", "type": "object", "x-event-categories": [], "x-title-plural": "Individuals" }, "type": "array", "x-documentation-priority": "default" }, "name": { "description": "The entity's name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "individuals" ], "title": "Entity Joint", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Joints", "nullable": true }, "natural_person": { "additionalProperties": false, "description": "Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.", "properties": { "address": { "additionalProperties": false, "description": "The person's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Individual Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number_last4": { "description": "The last 4 digits of the identification number that can be used to verify the individual's identity.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "method", "number_last4" ], "title": "Entity Individual Identification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Identifications", "nullable": true }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "title": "Entity Individual", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Individuals", "nullable": true }, "risk_rating": { "additionalProperties": false, "description": "An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.", "properties": { "rated_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "rating": { "description": "The rating given to this entity.", "enum": [ "low", "medium", "high" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Minimal risk of involvement in financial crime.", "Moderate risk of involvement in financial crime.", "Elevated risk of involvement in financial crime." ] } }, "required": [ "rating", "rated_at" ], "title": "Entity RiskRating", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "RiskRatings", "nullable": true }, "status": { "description": "The status of the entity.", "enum": [ "active", "archived", "disabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The entity is active.", "The entity is archived, and can no longer be used to create accounts.", "The entity is temporarily disabled and cannot be used for financial activity." ] }, "structure": { "description": "The entity's legal structure.", "enum": [ "corporation", "natural_person", "joint", "trust", "government_authority" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A corporation.", "An individual person.", "Multiple individual people.", "A trust.", "A government authority." ] }, "supplemental_documents": { "description": "Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them.", "items": { "$ref": "#/components/schemas/entity_supplemental_document" }, "type": "array", "x-documentation-priority": "default" }, "terms_agreements": { "description": "The terms that the Entity agreed to. Not all programs are required to submit this data.", "items": { "additionalProperties": false, "properties": { "agreed_at": { "description": "The timestamp of when the Entity agreed to the terms.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "ip_address": { "description": "The IP address the Entity accessed reviewed the terms from.", "type": "string", "x-documentation-priority": "default" }, "terms_url": { "description": "The URL of the terms agreement. This link will be provided by your bank partner.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "terms_url", "ip_address", "agreed_at" ], "title": "Entity TermsAgreementsElement", "type": "object", "x-event-categories": [], "x-title-plural": "TermsAgreementsElements" }, "type": "array", "x-documentation-priority": "default" }, "third_party_verification": { "additionalProperties": false, "description": "If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.", "properties": { "reference": { "description": "The reference identifier for the third party verification.", "type": "string", "x-documentation-priority": "default" }, "vendor": { "description": "The vendor that was used to perform the verification.", "enum": [ "alloy", "middesk", "oscilar", "persona", "taktile" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Alloy. See https://alloy.com for more information.", "Middesk. See https://middesk.com for more information.", "Oscilar. See https://oscilar.com for more information.", "Persona. See https://withpersona.com for more information.", "Taktile. See https://taktile.com for more information." ] } }, "required": [ "reference", "vendor" ], "title": "Entity ThirdPartyVerification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ThirdPartyVerifications", "nullable": true }, "trust": { "additionalProperties": false, "description": "Details of the trust entity. Will be present if `structure` is equal to `trust`.", "properties": { "address": { "additionalProperties": false, "description": "The trust's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Trust Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "category": { "description": "Whether the trust is `revocable` or `irrevocable`.", "enum": [ "revocable", "irrevocable" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The trust is revocable by the grantor.", "The trust cannot be revoked." ] }, "formation_document_file_id": { "description": "The ID for the File containing the formation document of the trust.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "formation_state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "grantor": { "additionalProperties": false, "description": "The grantor of the trust. Will be present if the `category` is `revocable`.", "properties": { "address": { "additionalProperties": false, "description": "The person's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Trust Individual Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number_last4": { "description": "The last 4 digits of the identification number that can be used to verify the individual's identity.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "method", "number_last4" ], "title": "Entity Trust Individual Identification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Identifications", "nullable": true }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "title": "Entity Trust Individual", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Individuals", "nullable": true }, "name": { "description": "The trust's name.", "type": "string", "x-documentation-priority": "default" }, "tax_identifier": { "description": "The Employer Identification Number (EIN) of the trust itself.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trustees": { "description": "The trustees of the trust.", "items": { "additionalProperties": false, "properties": { "individual": { "additionalProperties": false, "description": "The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`.", "properties": { "address": { "additionalProperties": false, "description": "The person's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Entity Trust TrusteesElement Individual Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number_last4": { "description": "The last 4 digits of the identification number that can be used to verify the individual's identity.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "method", "number_last4" ], "title": "Entity Trust TrusteesElement Individual Identification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Identifications", "nullable": true }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "title": "Entity Trust TrusteesElement Individual", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Individuals", "nullable": true }, "structure": { "description": "The structure of the trustee. Will always be equal to `individual`.", "enum": [ "individual" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The trustee is an individual." ] } }, "required": [ "structure", "individual" ], "title": "Entity Trust TrusteesElement", "type": "object", "x-event-categories": [], "x-title-plural": "TrusteesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "name", "category", "address", "formation_state", "tax_identifier", "trustees", "grantor", "formation_document_file_id" ], "title": "Entity Trust", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Trusts", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `entity`.", "enum": [ "entity" ], "type": "string", "x-documentation-priority": "default" }, "validation": { "additionalProperties": false, "description": "The validation results for the entity. Learn more about [validations](/documentation/entity-validation).", "properties": { "issues": { "description": "The list of issues that need to be addressed.", "items": { "additionalProperties": false, "properties": { "beneficial_owner_address": { "additionalProperties": false, "description": "Details when the issue is with a beneficial owner's address.", "properties": { "beneficial_owner_id": { "description": "The ID of the beneficial owner.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" }, "reason": { "description": "The reason the address is invalid.", "enum": [ "mailbox_address" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The address is a mailbox or other non-physical address." ] } }, "required": [ "beneficial_owner_id", "reason" ], "title": "Entity EntityValidation IssuesElement BeneficialOwnerAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "BeneficialOwnerAddresses", "nullable": true }, "beneficial_owner_identity": { "additionalProperties": false, "description": "Details when the issue is with a beneficial owner's identity verification.", "properties": { "beneficial_owner_id": { "description": "The ID of the beneficial owner.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" } }, "required": [ "beneficial_owner_id" ], "title": "Entity EntityValidation IssuesElement BeneficialOwnerIdentity", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "BeneficialOwnerIdentities", "nullable": true }, "category": { "description": "The type of issue. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "entity_tax_identifier", "entity_address", "beneficial_owner_identity", "beneficial_owner_address" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).", "The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).", "A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).", "A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner)." ] }, "entity_address": { "additionalProperties": false, "description": "Details when the issue is with the entity's address.", "properties": { "reason": { "description": "The reason the address is invalid.", "enum": [ "mailbox_address" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The address is a mailbox or other non-physical address." ] } }, "required": [ "reason" ], "title": "Entity EntityValidation IssuesElement EntityAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "EntityAddresses", "nullable": true }, "entity_tax_identifier": { "additionalProperties": false, "description": "Details when the issue is with the entity's tax ID.", "properties": {}, "title": "Entity EntityValidation IssuesElement EntityTaxIdentifier", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "EntityTaxIdentifiers", "nullable": true } }, "required": [ "category", "entity_tax_identifier", "entity_address", "beneficial_owner_identity", "beneficial_owner_address" ], "title": "Entity EntityValidation IssuesElement", "type": "object", "x-event-categories": [], "x-title-plural": "IssuesElements" }, "type": "array", "x-documentation-priority": "default" }, "status": { "description": "The validation status for the entity. If the status is `invalid`, the `issues` array will be populated.", "enum": [ "pending", "valid", "invalid" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The submitted data is being validated.", "The submitted data is valid.", "Additional information is required to validate the data." ] } }, "required": [ "status", "issues" ], "title": "Entity EntityValidation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "type", "id", "structure", "corporation", "natural_person", "joint", "government_authority", "trust", "idempotency_key", "third_party_verification", "risk_rating", "terms_agreements", "description", "status", "details_confirmed_at", "creating_entity_onboarding_session_id", "created_at", "validation", "supplemental_documents" ], "title": "Entity", "type": "object", "x-event-categories": [ "entity.created", "entity.updated" ], "x-tag": "Entities", "x-title-plural": "Entities" }, "entity_beneficial_owner": { "additionalProperties": false, "description": "Beneficial owners are the individuals who control or own 25% or more of a `corporation` entity. Beneficial owners are always people, and never organizations. Generally, you will need to submit between 1 and 5 beneficial owners for every `corporation` entity. You should update and archive beneficial owners for a corporation entity as their details change.", "example": { "company_title": "CEO", "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "idempotency_key": null, "individual": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number_last4": "1120" }, "name": "Ian Crease" }, "prongs": [ "control", "ownership" ], "type": "entity_beneficial_owner" }, "properties": { "company_title": { "description": "This person's role or title within the entity.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Beneficial Owner was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "entity_id": { "description": "The identifier of the Entity to which this beneficial owner belongs.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "id": { "description": "The identifier of this beneficial owner.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "individual": { "additionalProperties": false, "description": "Personal details for the beneficial owner.", "properties": { "address": { "additionalProperties": false, "description": "The person's address.", "example": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "zip": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "zip", "country" ], "title": "Beneficial Owner Individual Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "date_of_birth": { "description": "The person's date of birth in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number_last4": { "description": "The last 4 digits of the identification number that can be used to verify the individual's identity.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "method", "number_last4" ], "title": "Beneficial Owner Individual Identification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Identifications", "nullable": true }, "name": { "description": "The person's legal name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "date_of_birth", "address", "identification" ], "title": "Beneficial Owner Individual", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Individuals" }, "prongs": { "description": "Why this person is considered a beneficial owner of the entity.", "items": { "enum": [ "ownership", "control" ], "type": "string", "x-enum-descriptions": [ "A person with 25% or greater direct or indirect ownership of the entity.", "A person who manages, directs, or has significant control of the entity." ] }, "type": "array", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `entity_beneficial_owner`.", "enum": [ "entity_beneficial_owner" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "id", "entity_id", "individual", "created_at", "company_title", "prongs", "idempotency_key", "type" ], "title": "Beneficial Owner", "type": "object", "x-event-categories": [], "x-tag": "Beneficial Owners", "x-title-plural": "Beneficial Owners" }, "entity_beneficial_owner_list": { "additionalProperties": true, "description": "A list of Beneficial Owner objects.", "example": { "data": [ { "company_title": "CEO", "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "idempotency_key": null, "individual": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number_last4": "1120" }, "name": "Ian Crease" }, "prongs": [ "control", "ownership" ], "type": "entity_beneficial_owner" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/entity_beneficial_owner" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Beneficial Owner List", "type": "object", "x-event-categories": [], "x-title-plural": "Beneficial Owner Lists" }, "entity_list": { "additionalProperties": true, "description": "A list of Entity objects.", "example": { "data": [ { "corporation": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "beneficial_owners": [ { "company_title": "CEO", "id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "individual": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number_last4": "1120" }, "name": "Ian Crease" }, "prongs": [ "control", "ownership" ] } ], "email": null, "incorporation_state": "NY", "industry_code": null, "legal_identifier": { "category": "us_employer_identification_number", "value": "602214076" }, "name": "National Phonograph Company", "website": "https://example.com" }, "created_at": "2020-01-31T23:59:59Z", "creating_entity_onboarding_session_id": null, "description": null, "details_confirmed_at": null, "government_authority": null, "id": "entity_n8y8tnk2p9339ti393yi", "idempotency_key": null, "joint": null, "natural_person": null, "risk_rating": null, "status": "active", "structure": "corporation", "supplemental_documents": [ { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "type": "entity_supplemental_document" } ], "terms_agreements": [ { "agreed_at": "2020-01-31T23:59:59Z", "ip_address": "128.32.0.1", "terms_url": "https://increase.com/example_terms" } ], "third_party_verification": null, "trust": null, "type": "entity", "validation": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/entity" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Entity List", "type": "object", "x-event-categories": [], "x-title-plural": "Entity Lists" }, "entity_onboarding_session": { "additionalProperties": false, "description": "Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're done, they'll be redirected back to your site. This API is used for [hosted onboarding](/documentation/hosted-onboarding).", "example": { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "expires_at": "2020-02-01T05:59:59+00:00", "id": "entity_onboarding_session_wid2ug11fsmvh3k9hymd", "idempotency_key": null, "program_id": "program_i2v2os4mwza1oetokh9i", "redirect_url": "https://example.com/onboarding/completed", "session_url": "https://onboarding.increase.com/onboarding/sessions?id=HIrdj46cXyyNqT5RDcIR38dzPqzRBgTdG84XwzOz", "status": "active", "type": "entity_onboarding_session" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "entity_id": { "description": "The identifier of the Entity associated with this session, if one has been created or was provided when creating the session.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities", "nullable": true }, "expires_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session will expire.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Entity Onboarding Session's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entity Onboarding Sessions" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "program_id": { "description": "The identifier of the Program the Entity will be onboarded to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" }, "redirect_url": { "description": "The URL to redirect to after the onboarding session is complete. Increase will include the query parameters `entity_onboarding_session_id` and `entity_id` when redirecting.", "type": "string", "x-documentation-priority": "default" }, "session_url": { "description": "The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The status of the onboarding session.", "enum": [ "active", "expired" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Entity Onboarding Session is active.", "The Entity Onboarding Session has expired." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `entity_onboarding_session`.", "enum": [ "entity_onboarding_session" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "entity_id", "created_at", "status", "expires_at", "redirect_url", "session_url", "program_id", "idempotency_key" ], "title": "Entity Onboarding Session", "type": "object", "x-event-categories": [], "x-tag": "Entity Onboarding Sessions", "x-title-plural": "Entity Onboarding Sessions" }, "entity_onboarding_session_list": { "additionalProperties": true, "description": "A list of Entity Onboarding Session objects.", "example": { "data": [ { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "expires_at": "2020-02-01T05:59:59+00:00", "id": "entity_onboarding_session_wid2ug11fsmvh3k9hymd", "idempotency_key": null, "program_id": "program_i2v2os4mwza1oetokh9i", "redirect_url": "https://example.com/onboarding/completed", "session_url": "https://onboarding.increase.com/onboarding/sessions?id=HIrdj46cXyyNqT5RDcIR38dzPqzRBgTdG84XwzOz", "status": "active", "type": "entity_onboarding_session" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/entity_onboarding_session" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Entity Onboarding Session List", "type": "object", "x-event-categories": [], "x-title-plural": "Entity Onboarding Session Lists" }, "entity_supplemental_document": { "additionalProperties": false, "description": "Supplemental Documents are uploaded files connected to an Entity during onboarding.", "example": { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "type": "entity_supplemental_document" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental Document was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "entity_id": { "description": "The Entity the supplemental document is attached to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "file_id": { "description": "The File containing the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `entity_supplemental_document`.", "enum": [ "entity_supplemental_document" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "entity_id", "file_id", "created_at", "idempotency_key" ], "title": "Supplemental Document", "type": "object", "x-event-categories": [], "x-tag": "Supplemental Documents", "x-title-plural": "Supplemental Documents" }, "entity_supplemental_document_list": { "additionalProperties": true, "description": "A list of Supplemental Document objects.", "example": { "data": [ { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "type": "entity_supplemental_document" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/entity_supplemental_document" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Supplemental Document List", "type": "object", "x-event-categories": [], "x-title-plural": "Supplemental Document Lists" }, "error": { "anyOf": [ { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 404 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "api_method_not_found_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 403 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "environment_mismatch_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "resource_id": { "description": "", "type": "string", "x-documentation-priority": "default" }, "status": { "enum": [ 409 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "idempotency_key_already_used_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status", "resource_id" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 403 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "insufficient_permissions_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 500 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "internal_server_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "reason": { "description": "", "enum": [ "deleted_credential", "expired_credential", "ip_not_allowed", "no_credential", "no_header", "no_api_access", "wrong_environment" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "deleted_credential", "expired_credential", "ip_not_allowed", "no_credential", "no_header", "no_api_access", "wrong_environment" ] }, "status": { "enum": [ 401 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "invalid_api_key_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status", "reason" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 409 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "invalid_operation_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "errors": { "description": "All errors related to parsing the request parameters.", "items": { "additionalProperties": true, "properties": {}, "title": "ErrorsElement", "type": "object", "x-event-categories": [], "x-title-plural": "ErrorsElements" }, "type": "array", "x-documentation-priority": "default" }, "status": { "enum": [ 400 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "invalid_parameters_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status", "errors" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 400 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "malformed_request_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 404 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "object_not_found_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "status": { "enum": [ 403 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "private_feature_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] }, { "properties": { "detail": { "type": "string", "nullable": true }, "retry_after": { "description": "", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "status": { "enum": [ 429 ], "type": "integer" }, "title": { "type": "string" }, "type": { "enum": [ "rate_limited_error" ], "type": "string" } }, "required": [ "type", "title", "detail", "status" ], "type": "object", "x-event-categories": [] } ] }, "event": { "additionalProperties": false, "description": "Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).", "example": { "associated_object_id": "account_in71c4amph0vgo2qllky", "associated_object_type": "account", "category": "account.created", "created_at": "2020-01-31T23:59:59Z", "id": "event_001dzz0r20rzr4zrhrr1364hy80", "type": "event" }, "properties": { "associated_object_id": { "description": "The identifier of the object that generated this Event.", "type": "string", "x-documentation-priority": "default" }, "associated_object_type": { "description": "The type of the object that generated this Event.", "type": "string", "x-documentation-priority": "default" }, "category": { "description": "The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "blockchain_address.created", "blockchain_address.updated", "blockchain_offramp_transfer.created", "blockchain_offramp_transfer.updated", "blockchain_onramp_transfer.created", "blockchain_onramp_transfer.updated", "bookkeeping_account.created", "bookkeeping_account.updated", "bookkeeping_entry_set.updated", "card.created", "card.updated", "card_payment.created", "card_payment.updated", "card_purchase_supplement.created", "card_profile.created", "card_profile.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_card_profile.created", "digital_card_profile.updated", "digital_wallet_token.created", "digital_wallet_token.updated", "entity.created", "entity.updated", "event_subscription.created", "event_subscription.updated", "export.created", "export.updated", "external_account.created", "external_account.updated", "fednow_transfer.created", "fednow_transfer.updated", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer.created", "inbound_ach_transfer.updated", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_check_deposit.created", "inbound_check_deposit.updated", "inbound_fednow_transfer.created", "inbound_fednow_transfer.updated", "inbound_mail_item.created", "inbound_mail_item.updated", "inbound_real_time_payments_transfer.created", "inbound_real_time_payments_transfer.updated", "inbound_wire_drawdown_request.created", "inbound_wire_transfer.created", "inbound_wire_transfer.updated", "intrafi_account_enrollment.created", "intrafi_account_enrollment.updated", "intrafi_exclusion.created", "intrafi_exclusion.updated", "lockbox.created", "lockbox.updated", "oauth_connection.created", "oauth_connection.deactivated", "card_push_transfer.created", "card_push_transfer.updated", "card_validation.created", "card_validation.updated", "pending_transaction.created", "pending_transaction.updated", "physical_card.created", "physical_card.updated", "physical_card_profile.created", "physical_card_profile.updated", "physical_check.created", "physical_check.updated", "program.created", "program.updated", "proof_of_authorization_request.created", "proof_of_authorization_request.updated", "real_time_decision.card_authorization_requested", "real_time_decision.card_balance_inquiry_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_decision.card_authentication_requested", "real_time_decision.card_authentication_challenge_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "swift_transfer.created", "swift_transfer.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Occurs whenever an Account is created.", "Occurs whenever an Account is updated.", "Occurs whenever an Account Number is created.", "Occurs whenever an Account Number is updated.", "Occurs whenever an Account Statement is created.", "Occurs whenever an Account Transfer is created.", "Occurs whenever an Account Transfer is updated.", "Occurs whenever an ACH Prenotification is created.", "Occurs whenever an ACH Prenotification is updated.", "Occurs whenever an ACH Transfer is created.", "Occurs whenever an ACH Transfer is updated.", "Occurs whenever a Blockchain Address is created.", "Occurs whenever a Blockchain Address is updated.", "Occurs whenever a Blockchain Off-Ramp Transfer is created.", "Occurs whenever a Blockchain Off-Ramp Transfer is updated.", "Occurs whenever a Blockchain On-Ramp Transfer is created.", "Occurs whenever a Blockchain On-Ramp Transfer is updated.", "Occurs whenever a Bookkeeping Account is created.", "Occurs whenever a Bookkeeping Account is updated.", "Occurs whenever a Bookkeeping Entry Set is created.", "Occurs whenever a Card is created.", "Occurs whenever a Card is updated.", "Occurs whenever a Card Payment is created.", "Occurs whenever a Card Payment is updated.", "Occurs whenever a Card Purchase Supplement is created.", "Occurs whenever a Card Profile is created.", "Occurs whenever a Card Profile is updated.", "Occurs whenever a Card Dispute is created.", "Occurs whenever a Card Dispute is updated.", "Occurs whenever a Check Deposit is created.", "Occurs whenever a Check Deposit is updated.", "Occurs whenever a Check Transfer is created.", "Occurs whenever a Check Transfer is updated.", "Occurs whenever a Declined Transaction is created.", "Occurs whenever a Digital Card Profile is created.", "Occurs whenever a Digital Card Profile is updated.", "Occurs whenever a Digital Wallet Token is created.", "Occurs whenever a Digital Wallet Token is updated.", "Occurs whenever an Entity is created.", "Occurs whenever an Entity is updated.", "Occurs whenever an Event Subscription is created.", "Occurs whenever an Event Subscription is updated.", "Occurs whenever an Export is created.", "Occurs whenever an Export is updated.", "Occurs whenever an External Account is created.", "Occurs whenever an External Account is updated.", "Occurs whenever a FedNow Transfer is created.", "Occurs whenever a FedNow Transfer is updated.", "Occurs whenever a File is created.", "Occurs whenever a Group is updated.", "Increase may send webhooks with this category to see if a webhook endpoint is working properly.", "Occurs whenever an Inbound ACH Transfer is created.", "Occurs whenever an Inbound ACH Transfer is updated.", "Occurs whenever an Inbound ACH Transfer Return is created.", "Occurs whenever an Inbound ACH Transfer Return is updated.", "Occurs whenever an Inbound Check Deposit is created.", "Occurs whenever an Inbound Check Deposit is updated.", "Occurs whenever an Inbound FedNow Transfer is created.", "Occurs whenever an Inbound FedNow Transfer is updated.", "Occurs whenever an Inbound Mail Item is created.", "Occurs whenever an Inbound Mail Item is updated.", "Occurs whenever an Inbound Real-Time Payments Transfer is created.", "Occurs whenever an Inbound Real-Time Payments Transfer is updated.", "Occurs whenever an Inbound Wire Drawdown Request is created.", "Occurs whenever an Inbound Wire Transfer is created.", "Occurs whenever an Inbound Wire Transfer is updated.", "Occurs whenever an IntraFi Account Enrollment is created.", "Occurs whenever an IntraFi Account Enrollment is updated.", "Occurs whenever an IntraFi Exclusion is created.", "Occurs whenever an IntraFi Exclusion is updated.", "Occurs whenever a Lockbox is created.", "Occurs whenever a Lockbox is updated.", "Occurs whenever an OAuth Connection is created.", "Occurs whenever an OAuth Connection is deactivated.", "Occurs whenever a Card Push Transfer is created.", "Occurs whenever a Card Push Transfer is updated.", "Occurs whenever a Card Validation is created.", "Occurs whenever a Card Validation is updated.", "Occurs whenever a Pending Transaction is created.", "Occurs whenever a Pending Transaction is updated.", "Occurs whenever a Physical Card is created.", "Occurs whenever a Physical Card is updated.", "Occurs whenever a Physical Card Profile is created.", "Occurs whenever a Physical Card Profile is updated.", "Occurs whenever a Physical Check is created.", "Occurs whenever a Physical Check is updated.", "Occurs whenever a Program is created.", "Occurs whenever a Program is updated.", "Occurs whenever a Proof of Authorization Request is created.", "Occurs whenever a Proof of Authorization Request is updated.", "Occurs whenever a Real-Time Decision is created in response to a card authorization.", "Occurs whenever a Real-Time Decision is created in response to a card balance inquiry.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication challenges.", "Occurs whenever a Real-Time Payments Transfer is created.", "Occurs whenever a Real-Time Payments Transfer is updated.", "Occurs whenever a Real-Time Payments Request for Payment is created.", "Occurs whenever a Real-Time Payments Request for Payment is updated.", "Occurs whenever a Swift Transfer is created.", "Occurs whenever a Swift Transfer is updated.", "Occurs whenever a Transaction is created.", "Occurs whenever a Wire Drawdown Request is created.", "Occurs whenever a Wire Drawdown Request is updated.", "Occurs whenever a Wire Transfer is created.", "Occurs whenever a Wire Transfer is updated." ] }, "created_at": { "description": "The time the Event was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Event identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Events" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `event`.", "enum": [ "event" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "associated_object_id", "associated_object_type", "category", "created_at", "id" ], "title": "Event", "type": "object", "x-event-categories": [], "x-tag": "Events", "x-title-plural": "Events" }, "event_list": { "additionalProperties": true, "description": "A list of Event objects.", "example": { "data": [ { "associated_object_id": "account_in71c4amph0vgo2qllky", "associated_object_type": "account", "category": "account.created", "created_at": "2020-01-31T23:59:59Z", "id": "event_001dzz0r20rzr4zrhrr1364hy80", "type": "event" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/event" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Event List", "type": "object", "x-event-categories": [], "x-title-plural": "Event Lists" }, "event_subscription": { "additionalProperties": true, "description": "Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).", "example": { "created_at": "2020-01-31T23:59:59Z", "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "idempotency_key": null, "oauth_connection_id": null, "selected_event_categories": null, "status": "active", "type": "event_subscription", "url": "https://website.com/webhooks" }, "properties": { "created_at": { "description": "The time the event subscription was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The event subscription identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Event Subscriptions" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "oauth_connection_id": { "description": "If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "OAuth Connections", "nullable": true }, "selected_event_categories": { "description": "If specified, this subscription will only receive webhooks for Events with the specified `category`.", "items": { "additionalProperties": false, "properties": { "event_category": { "description": "The category of the Event.", "enum": [ "account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "blockchain_address.created", "blockchain_address.updated", "blockchain_offramp_transfer.created", "blockchain_offramp_transfer.updated", "blockchain_onramp_transfer.created", "blockchain_onramp_transfer.updated", "bookkeeping_account.created", "bookkeeping_account.updated", "bookkeeping_entry_set.updated", "card.created", "card.updated", "card_payment.created", "card_payment.updated", "card_purchase_supplement.created", "card_profile.created", "card_profile.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_card_profile.created", "digital_card_profile.updated", "digital_wallet_token.created", "digital_wallet_token.updated", "entity.created", "entity.updated", "event_subscription.created", "event_subscription.updated", "export.created", "export.updated", "external_account.created", "external_account.updated", "fednow_transfer.created", "fednow_transfer.updated", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer.created", "inbound_ach_transfer.updated", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_check_deposit.created", "inbound_check_deposit.updated", "inbound_fednow_transfer.created", "inbound_fednow_transfer.updated", "inbound_mail_item.created", "inbound_mail_item.updated", "inbound_real_time_payments_transfer.created", "inbound_real_time_payments_transfer.updated", "inbound_wire_drawdown_request.created", "inbound_wire_transfer.created", "inbound_wire_transfer.updated", "intrafi_account_enrollment.created", "intrafi_account_enrollment.updated", "intrafi_exclusion.created", "intrafi_exclusion.updated", "lockbox.created", "lockbox.updated", "oauth_connection.created", "oauth_connection.deactivated", "card_push_transfer.created", "card_push_transfer.updated", "card_validation.created", "card_validation.updated", "pending_transaction.created", "pending_transaction.updated", "physical_card.created", "physical_card.updated", "physical_card_profile.created", "physical_card_profile.updated", "physical_check.created", "physical_check.updated", "program.created", "program.updated", "proof_of_authorization_request.created", "proof_of_authorization_request.updated", "real_time_decision.card_authorization_requested", "real_time_decision.card_balance_inquiry_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_decision.card_authentication_requested", "real_time_decision.card_authentication_challenge_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "swift_transfer.created", "swift_transfer.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Occurs whenever an Account is created.", "Occurs whenever an Account is updated.", "Occurs whenever an Account Number is created.", "Occurs whenever an Account Number is updated.", "Occurs whenever an Account Statement is created.", "Occurs whenever an Account Transfer is created.", "Occurs whenever an Account Transfer is updated.", "Occurs whenever an ACH Prenotification is created.", "Occurs whenever an ACH Prenotification is updated.", "Occurs whenever an ACH Transfer is created.", "Occurs whenever an ACH Transfer is updated.", "Occurs whenever a Blockchain Address is created.", "Occurs whenever a Blockchain Address is updated.", "Occurs whenever a Blockchain Off-Ramp Transfer is created.", "Occurs whenever a Blockchain Off-Ramp Transfer is updated.", "Occurs whenever a Blockchain On-Ramp Transfer is created.", "Occurs whenever a Blockchain On-Ramp Transfer is updated.", "Occurs whenever a Bookkeeping Account is created.", "Occurs whenever a Bookkeeping Account is updated.", "Occurs whenever a Bookkeeping Entry Set is created.", "Occurs whenever a Card is created.", "Occurs whenever a Card is updated.", "Occurs whenever a Card Payment is created.", "Occurs whenever a Card Payment is updated.", "Occurs whenever a Card Purchase Supplement is created.", "Occurs whenever a Card Profile is created.", "Occurs whenever a Card Profile is updated.", "Occurs whenever a Card Dispute is created.", "Occurs whenever a Card Dispute is updated.", "Occurs whenever a Check Deposit is created.", "Occurs whenever a Check Deposit is updated.", "Occurs whenever a Check Transfer is created.", "Occurs whenever a Check Transfer is updated.", "Occurs whenever a Declined Transaction is created.", "Occurs whenever a Digital Card Profile is created.", "Occurs whenever a Digital Card Profile is updated.", "Occurs whenever a Digital Wallet Token is created.", "Occurs whenever a Digital Wallet Token is updated.", "Occurs whenever an Entity is created.", "Occurs whenever an Entity is updated.", "Occurs whenever an Event Subscription is created.", "Occurs whenever an Event Subscription is updated.", "Occurs whenever an Export is created.", "Occurs whenever an Export is updated.", "Occurs whenever an External Account is created.", "Occurs whenever an External Account is updated.", "Occurs whenever a FedNow Transfer is created.", "Occurs whenever a FedNow Transfer is updated.", "Occurs whenever a File is created.", "Occurs whenever a Group is updated.", "Increase may send webhooks with this category to see if a webhook endpoint is working properly.", "Occurs whenever an Inbound ACH Transfer is created.", "Occurs whenever an Inbound ACH Transfer is updated.", "Occurs whenever an Inbound ACH Transfer Return is created.", "Occurs whenever an Inbound ACH Transfer Return is updated.", "Occurs whenever an Inbound Check Deposit is created.", "Occurs whenever an Inbound Check Deposit is updated.", "Occurs whenever an Inbound FedNow Transfer is created.", "Occurs whenever an Inbound FedNow Transfer is updated.", "Occurs whenever an Inbound Mail Item is created.", "Occurs whenever an Inbound Mail Item is updated.", "Occurs whenever an Inbound Real-Time Payments Transfer is created.", "Occurs whenever an Inbound Real-Time Payments Transfer is updated.", "Occurs whenever an Inbound Wire Drawdown Request is created.", "Occurs whenever an Inbound Wire Transfer is created.", "Occurs whenever an Inbound Wire Transfer is updated.", "Occurs whenever an IntraFi Account Enrollment is created.", "Occurs whenever an IntraFi Account Enrollment is updated.", "Occurs whenever an IntraFi Exclusion is created.", "Occurs whenever an IntraFi Exclusion is updated.", "Occurs whenever a Lockbox is created.", "Occurs whenever a Lockbox is updated.", "Occurs whenever an OAuth Connection is created.", "Occurs whenever an OAuth Connection is deactivated.", "Occurs whenever a Card Push Transfer is created.", "Occurs whenever a Card Push Transfer is updated.", "Occurs whenever a Card Validation is created.", "Occurs whenever a Card Validation is updated.", "Occurs whenever a Pending Transaction is created.", "Occurs whenever a Pending Transaction is updated.", "Occurs whenever a Physical Card is created.", "Occurs whenever a Physical Card is updated.", "Occurs whenever a Physical Card Profile is created.", "Occurs whenever a Physical Card Profile is updated.", "Occurs whenever a Physical Check is created.", "Occurs whenever a Physical Check is updated.", "Occurs whenever a Program is created.", "Occurs whenever a Program is updated.", "Occurs whenever a Proof of Authorization Request is created.", "Occurs whenever a Proof of Authorization Request is updated.", "Occurs whenever a Real-Time Decision is created in response to a card authorization.", "Occurs whenever a Real-Time Decision is created in response to a card balance inquiry.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication challenges.", "Occurs whenever a Real-Time Payments Transfer is created.", "Occurs whenever a Real-Time Payments Transfer is updated.", "Occurs whenever a Real-Time Payments Request for Payment is created.", "Occurs whenever a Real-Time Payments Request for Payment is updated.", "Occurs whenever a Swift Transfer is created.", "Occurs whenever a Swift Transfer is updated.", "Occurs whenever a Transaction is created.", "Occurs whenever a Wire Drawdown Request is created.", "Occurs whenever a Wire Drawdown Request is updated.", "Occurs whenever a Wire Transfer is created.", "Occurs whenever a Wire Transfer is updated." ], "nullable": true } }, "required": [ "event_category" ], "title": "Event Subscription SelectedEventCategoriesElement", "type": "object", "x-event-categories": [], "x-title-plural": "SelectedEventCategoriesElements" }, "type": "array", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "This indicates if we'll send notifications to this subscription.", "enum": [ "active", "disabled", "deleted", "requires_attention" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The subscription is active and Events will be delivered normally.", "The subscription is temporarily disabled and Events will not be delivered.", "The subscription is permanently disabled and Events will not be delivered.", "The subscription is temporarily disabled due to delivery errors and Events will not be delivered." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `event_subscription`.", "enum": [ "event_subscription" ], "type": "string", "x-documentation-priority": "default" }, "url": { "description": "The webhook url where we'll send notifications.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "status", "selected_event_categories", "oauth_connection_id", "url", "idempotency_key" ], "title": "Event Subscription", "type": "object", "x-event-categories": [ "event_subscription.created", "event_subscription.updated" ], "x-tag": "Event Subscriptions", "x-title-plural": "Event Subscriptions" }, "event_subscription_list": { "additionalProperties": true, "description": "A list of Event Subscription objects.", "example": { "data": [ { "created_at": "2020-01-31T23:59:59Z", "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "idempotency_key": null, "oauth_connection_id": null, "selected_event_categories": null, "status": "active", "type": "event_subscription", "url": "https://website.com/webhooks" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/event_subscription" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Event Subscription List", "type": "object", "x-event-categories": [], "x-title-plural": "Event Subscription Lists" }, "export": { "additionalProperties": true, "description": "Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports).", "example": { "account_statement_bai2": null, "account_statement_ofx": null, "account_verification_letter": null, "balance_csv": null, "bookkeeping_account_balance_csv": null, "category": "transaction_csv", "created_at": "2020-01-31T23:59:59Z", "daily_account_balance_csv": null, "dashboard_table_csv": null, "entity_csv": null, "fee_csv": null, "form_1099_int": null, "form_1099_misc": null, "funding_instructions": null, "id": "export_8s4m48qz3bclzje0zwh9", "idempotency_key": null, "result": { "file_id": "file_makxrc67oh9l6sg7w9yc" }, "status": "complete", "transaction_csv": { "account_id": "account_in71c4amph0vgo2qllky", "created_at": null }, "type": "export", "vendor_csv": null, "voided_check": null }, "properties": { "account_statement_bai2": { "additionalProperties": false, "description": "Details of the account statement BAI2 export. This field will be present when the `category` is equal to `account_statement_bai2`.", "properties": { "account_id": { "description": "Filter results by Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true }, "effective_date": { "description": "The date for which to retrieve the balance.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "program_id": { "description": "Filter results by Program.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs", "nullable": true } }, "required": [ "account_id", "program_id", "effective_date" ], "title": "Export AccountStatementBAI2", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "account_statement_ofx": { "additionalProperties": false, "description": "Details of the account statement OFX export. This field will be present when the `category` is equal to `account_statement_ofx`.", "properties": { "account_id": { "description": "The Account to create a statement for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "created_at": { "additionalProperties": false, "description": "Filter transactions by their created date.", "properties": { "before": { "description": "Filter results to transactions created before this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "on_or_after": { "description": "Filter results to transactions created on or after this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "before", "on_or_after" ], "title": "Export AccountStatementOFX CreatedAt", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CreatedAts", "nullable": true } }, "required": [ "account_id", "created_at" ], "title": "Export AccountStatementOFX", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "account_verification_letter": { "additionalProperties": false, "description": "Details of the account verification letter export. This field will be present when the `category` is equal to `account_verification_letter`.", "properties": { "account_number_id": { "description": "The Account Number to create a letter for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "balance_date": { "description": "The date of the balance to include in the letter.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "account_number_id", "balance_date" ], "title": "Export AccountVerificationLetter", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "balance_csv": { "additionalProperties": false, "description": "Details of the balance CSV export. This field will be present when the `category` is equal to `balance_csv`.", "properties": { "account_id": { "description": "Filter results by Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true }, "created_at": { "additionalProperties": false, "description": "Filter balances by their created date.", "properties": { "after": { "description": "Filter balances created after this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "before": { "description": "Filter balances created before this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "after", "before" ], "title": "Export BalanceCSV CreatedAt", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CreatedAts", "nullable": true } }, "required": [ "account_id", "created_at" ], "title": "Export BalanceCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "bookkeeping_account_balance_csv": { "additionalProperties": false, "description": "Details of the bookkeeping account balance CSV export. This field will be present when the `category` is equal to `bookkeeping_account_balance_csv`.", "properties": { "bookkeeping_account_id": { "description": "Filter results by Bookkeeping Account.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "on_or_after_date": { "description": "Filter balances to those on or after this date.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "on_or_before_date": { "description": "Filter balances to those on or before this date.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "bookkeeping_account_id", "on_or_before_date", "on_or_after_date" ], "title": "Export BookkeepingAccountBalanceCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "category": { "description": "The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.", "enum": [ "account_statement_ofx", "account_statement_bai2", "transaction_csv", "balance_csv", "bookkeeping_account_balance_csv", "entity_csv", "vendor_csv", "dashboard_table_csv", "account_verification_letter", "funding_instructions", "form_1099_int", "form_1099_misc", "fee_csv", "voided_check", "daily_account_balance_csv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.", "Export a BAI2 file of transactions and balances for a given date and optional Account.", "Export a CSV of all transactions for a given time range.", "Export a CSV of account balances for the dates in a given range.", "Export a CSV of bookkeeping account balances for the dates in a given range.", "Export a CSV of entities with a given status.", "Export a CSV of vendors added to the third-party risk management dashboard.", "Certain dashboard tables are available as CSV exports. This export cannot be created via the API.", "A PDF of an account verification letter.", "A PDF of funding instructions.", "A PDF of an Internal Revenue Service Form 1099-INT.", "A PDF of an Internal Revenue Service Form 1099-MISC.", "Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.", "A PDF of a voided check.", "Export a CSV of daily account balances with starting and ending balances for a given date range." ] }, "created_at": { "description": "The time the Export was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "daily_account_balance_csv": { "additionalProperties": false, "description": "Details of the daily account balance CSV export. This field will be present when the `category` is equal to `daily_account_balance_csv`.", "properties": { "account_id": { "description": "Filter results by Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true }, "on_or_after_date": { "description": "Filter balances on or after this date.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true }, "on_or_before_date": { "description": "Filter balances on or before this date.", "format": "date", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "account_id", "on_or_after_date", "on_or_before_date" ], "title": "Export DailyAccountBalanceCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dashboard_table_csv": { "additionalProperties": false, "description": "Details of the dashboard table CSV export. This field will be present when the `category` is equal to `dashboard_table_csv`.", "properties": {}, "title": "Export DashboardTableCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "entity_csv": { "additionalProperties": false, "description": "Details of the entity CSV export. This field will be present when the `category` is equal to `entity_csv`.", "properties": {}, "title": "Export EntityCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "fee_csv": { "additionalProperties": false, "description": "Details of the fee CSV export. This field will be present when the `category` is equal to `fee_csv`.", "properties": { "created_at": { "additionalProperties": false, "description": "Filter fees by their created date. The time range must not include any fees that are part of an open fee statement.", "properties": { "after": { "description": "Filter fees created after this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "before": { "description": "Filter fees created before this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "after", "before" ], "title": "Export FeeCSV CreatedAt", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CreatedAts", "nullable": true } }, "required": [ "created_at" ], "title": "Export FeeCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "form_1099_int": { "additionalProperties": false, "description": "Details of the Form 1099-INT export. This field will be present when the `category` is equal to `form_1099_int`.", "properties": { "account_id": { "description": "The Account the tax form is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "corrected": { "description": "Whether the tax form is a corrected form.", "type": "boolean", "x-documentation-priority": "default" }, "description": { "description": "A description of the tax form.", "type": "string", "x-documentation-priority": "default" }, "year": { "description": "The tax year for the tax form.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "account_id", "description", "year", "corrected" ], "title": "Export Form1099INT", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "form_1099_misc": { "additionalProperties": false, "description": "Details of the Form 1099-MISC export. This field will be present when the `category` is equal to `form_1099_misc`.", "properties": { "account_id": { "description": "The Account the tax form is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "corrected": { "description": "Whether the tax form is a corrected form.", "type": "boolean", "x-documentation-priority": "default" }, "year": { "description": "The tax year for the tax form.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "account_id", "year", "corrected" ], "title": "Export Form1099Misc", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "funding_instructions": { "additionalProperties": false, "description": "Details of the funding instructions export. This field will be present when the `category` is equal to `funding_instructions`.", "properties": { "account_number_id": { "description": "The Account Number to create funding instructions for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, "required": [ "account_number_id" ], "title": "Export FundingInstructions", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "id": { "description": "The Export identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Exports" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "additionalProperties": false, "description": "The result of the Export. This will be present when the Export's status transitions to `complete`.", "properties": { "file_id": { "description": "The File containing the contents of the Export.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id" ], "title": "Export Result", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Results", "nullable": true }, "status": { "description": "The status of the Export.", "enum": [ "pending", "complete", "failed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase is generating the export.", "The export has been successfully generated.", "The export failed to generate. Increase will reach out to you to resolve the issue." ] }, "transaction_csv": { "additionalProperties": false, "description": "Details of the transaction CSV export. This field will be present when the `category` is equal to `transaction_csv`.", "properties": { "account_id": { "description": "Filter results by Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true }, "created_at": { "additionalProperties": false, "description": "Filter transactions by their created date.", "properties": { "after": { "description": "Filter transactions created after this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "before": { "description": "Filter transactions created before this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "after", "before" ], "title": "Export TransactionCSV CreatedAt", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CreatedAts", "nullable": true } }, "required": [ "account_id", "created_at" ], "title": "Export TransactionCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `export`.", "enum": [ "export" ], "type": "string", "x-documentation-priority": "default" }, "vendor_csv": { "additionalProperties": false, "description": "Details of the vendor CSV export. This field will be present when the `category` is equal to `vendor_csv`.", "properties": {}, "title": "Export VendorCSV", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "voided_check": { "additionalProperties": false, "description": "Details of the voided check export. This field will be present when the `category` is equal to `voided_check`.", "properties": { "account_number_id": { "description": "The Account Number for the voided check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "payer": { "description": "The payer information printed on the check.", "items": { "additionalProperties": false, "properties": { "line": { "description": "The contents of the line.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line" ], "title": "Export VoidedCheck PayerElement", "type": "object", "x-event-categories": [], "x-title-plural": "PayerElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "account_number_id", "payer" ], "title": "Export VoidedCheck", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "type", "id", "created_at", "category", "status", "result", "account_statement_ofx", "account_statement_bai2", "dashboard_table_csv", "transaction_csv", "balance_csv", "bookkeeping_account_balance_csv", "entity_csv", "vendor_csv", "account_verification_letter", "funding_instructions", "form_1099_int", "form_1099_misc", "fee_csv", "voided_check", "daily_account_balance_csv", "idempotency_key" ], "title": "Export", "type": "object", "x-event-categories": [ "export.created", "export.updated" ], "x-tag": "Exports", "x-title-plural": "Exports" }, "export_list": { "additionalProperties": true, "description": "A list of Export objects.", "example": { "data": [ { "account_statement_bai2": null, "account_statement_ofx": null, "account_verification_letter": null, "balance_csv": null, "bookkeeping_account_balance_csv": null, "category": "transaction_csv", "created_at": "2020-01-31T23:59:59Z", "daily_account_balance_csv": null, "dashboard_table_csv": null, "entity_csv": null, "fee_csv": null, "form_1099_int": null, "form_1099_misc": null, "funding_instructions": null, "id": "export_8s4m48qz3bclzje0zwh9", "idempotency_key": null, "result": { "file_id": "file_makxrc67oh9l6sg7w9yc" }, "status": "complete", "transaction_csv": { "account_id": "account_in71c4amph0vgo2qllky", "created_at": null }, "type": "export", "vendor_csv": null, "voided_check": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/export" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Export List", "type": "object", "x-event-categories": [], "x-title-plural": "Export Lists" }, "external_account": { "additionalProperties": true, "description": "External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.", "example": { "account_holder": "business", "account_number": "987654321", "created_at": "2020-01-31T23:59:59Z", "description": "Landlord", "funding": "checking", "id": "external_account_ukk55lr923a3ac0pp7iv", "idempotency_key": null, "routing_number": "101050001", "status": "active", "type": "external_account" }, "properties": { "account_holder": { "description": "The type of entity that owns the External Account.", "enum": [ "business", "individual", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is owned by a business.", "The External Account is owned by an individual.", "It's unknown what kind of entity owns the External Account." ] }, "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External Account was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "The External Account's description for display purposes.", "type": "string", "x-documentation-priority": "default" }, "funding": { "description": "The type of the account to which the transfer will be sent.", "enum": [ "checking", "savings", "general_ledger", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A checking account.", "A savings account.", "A general ledger account.", "A different type of account." ] }, "id": { "description": "The External Account's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The External Account's status.", "enum": [ "active", "archived" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is active.", "The External Account is archived and won't appear in the dashboard." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `external_account`.", "enum": [ "external_account" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "description", "status", "routing_number", "account_number", "funding", "account_holder", "idempotency_key" ], "title": "External Account", "type": "object", "x-event-categories": [ "external_account.created", "external_account.updated" ], "x-tag": "External Accounts", "x-title-plural": "External Accounts" }, "external_account_list": { "additionalProperties": true, "description": "A list of External Account objects.", "example": { "data": [ { "account_holder": "business", "account_number": "987654321", "created_at": "2020-01-31T23:59:59Z", "description": "Landlord", "funding": "checking", "id": "external_account_ukk55lr923a3ac0pp7iv", "idempotency_key": null, "routing_number": "101050001", "status": "active", "type": "external_account" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/external_account" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "External Account List", "type": "object", "x-event-categories": [], "x-title-plural": "External Account Lists" }, "fednow_transfer": { "additionalProperties": false, "description": "FedNow transfers move funds, within seconds, between your Increase account and any other account supporting FedNow.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "amount": 100, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_address": { "city": "New York", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_name": "National Phonograph Company", "external_account_id": null, "id": "fednow_transfer_4i0mptrdu1mueg1196bg", "idempotency_key": null, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "rejection": null, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "complete", "submission": { "message_identification": "20250308723260130GT4LAKENDXBHQCZDWS", "submitted_at": "2020-01-31T23:59:59Z" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "fednow_transfer", "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_id": { "description": "The Account from which the transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "acknowledgement": { "additionalProperties": false, "description": "If the transfer is acknowledged by the recipient bank, this will contain supplemental details.", "example": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "properties": { "acknowledged_at": { "description": "When the transfer was acknowledged.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "acknowledged_at" ], "title": "FedNow Transfer FedNow Transfer Acknowledgement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "FedNow Transfer Acknowledgements", "nullable": true }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "FedNow Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "FedNow Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "FedNow Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "FedNow Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "creditor_address": { "additionalProperties": false, "description": "The creditor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The ZIP code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The address state.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "city", "state", "postal_code" ], "title": "FedNow Transfer Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses", "nullable": true }, "creditor_name": { "description": "The name of the transfer's recipient. This is set by the sender when creating the transfer.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For FedNow transfers this is always equal to `USD`.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor_name": { "description": "The name of the transfer's sender. If not provided, defaults to the name of the account's entity.", "type": "string", "x-documentation-priority": "default" }, "external_account_id": { "description": "The identifier of the External Account the transfer was made to, if any.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts", "nullable": true }, "id": { "description": "The FedNow Transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "FedNow Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "rejection": { "additionalProperties": false, "description": "If the transfer is rejected by FedNow or the destination financial institution, this will contain supplemental details.", "example": { "reject_reason_additional_information": null, "reject_reason_code": "other", "rejected_at": "2020-01-31T23:59:59Z" }, "properties": { "reject_reason_additional_information": { "description": "Additional information about the rejection provided by the recipient bank.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reject_reason_code": { "description": "The reason the transfer was rejected as provided by the recipient bank or the FedNow network.", "enum": [ "account_closed", "account_blocked", "invalid_creditor_account_type", "invalid_creditor_account_number", "invalid_creditor_financial_institution_identifier", "end_customer_deceased", "narrative", "transaction_forbidden", "transaction_type_not_supported", "amount_exceeds_bank_limits", "invalid_creditor_address", "invalid_debtor_address", "timeout", "processing_error", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The destination account is closed. Corresponds to the FedNow reason code `AC04`.", "The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.", "The destination account is ineligible to receive FedNow transfers. Corresponds to the FedNow reason code `AC14`.", "The destination account does not exist. Corresponds to the FedNow reason code `AC03`.", "The destination routing number is invalid. Corresponds to the FedNow reason code `RC04`.", "The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.", "The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.", "FedNow transfers are not allowed to the destination account. Corresponds to the FedNow reason code `AG01`.", "FedNow transfers are not enabled for the destination account. Corresponds to the FedNow reason code `AG03`.", "The amount is higher than the recipient is authorized to send or receive. Corresponds to the FedNow reason code `E990`.", "The creditor's address is required, but missing or invalid. Corresponds to the FedNow reason code `BE04`.", "The debtor's address is required, but missing or invalid. Corresponds to the FedNow reason code `BE07`.", "There was a timeout processing the transfer. Corresponds to the FedNow reason code `E997`.", "The transfer was rejected due to an internal Increase issue. We have been notified.", "Some other error or issue has occurred." ] }, "rejected_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was rejected.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "rejected_at", "reject_reason_code", "reject_reason_additional_information" ], "title": "FedNow Transfer FedNow Transfer Rejection", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "FedNow Transfer Rejections", "nullable": true }, "routing_number": { "description": "The destination American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The Account Number the recipient will see as having sent the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_reviewing", "canceled", "reviewing_rejected", "requires_attention", "pending_approval", "pending_submitting", "pending_response", "complete", "rejected" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending review by Increase.", "The transfer has been canceled.", "The transfer has been rejected by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is pending approval.", "The transfer is queued to be submitted to FedNow.", "The transfer has been submitted and is pending a response from FedNow.", "The transfer has been sent successfully and is complete.", "The transfer was rejected by the network or the recipient's bank." ] }, "submission": { "additionalProperties": false, "description": "After the transfer is submitted to FedNow, this will contain supplemental details.", "example": { "message_identification": "20250308723260130GT4LAKENDXBHQCZDWS", "submitted_at": "2020-01-31T23:59:59Z" }, "properties": { "message_identification": { "description": "The FedNow network identification of the message submitted.", "type": "string", "x-documentation-priority": "default" }, "submitted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to FedNow.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "submitted_at", "message_identification" ], "title": "FedNow Transfer FedNow Transfer Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "FedNow Transfer Submissions", "nullable": true }, "transaction_id": { "description": "The Transaction funding the transfer once it is complete.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `fednow_transfer`.", "enum": [ "fednow_transfer" ], "type": "string", "x-documentation-priority": "default" }, "unique_end_to_end_transaction_reference": { "description": "The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.", "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Unstructured information that will show on the recipient's bank statement.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "status", "created_at", "account_id", "source_account_number_id", "debtor_name", "creditor_name", "creditor_address", "unstructured_remittance_information", "unique_end_to_end_transaction_reference", "amount", "currency", "account_number", "routing_number", "external_account_id", "transaction_id", "pending_transaction_id", "submission", "rejection", "acknowledgement", "created_by", "idempotency_key" ], "title": "FedNow Transfer", "type": "object", "x-event-categories": [ "fednow_transfer.created", "fednow_transfer.updated" ], "x-tag": "FedNow Transfers", "x-title-plural": "FedNow Transfers" }, "fednow_transfer_list": { "additionalProperties": true, "description": "A list of FedNow Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "amount": 100, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_address": { "city": "New York", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_name": "National Phonograph Company", "external_account_id": null, "id": "fednow_transfer_4i0mptrdu1mueg1196bg", "idempotency_key": null, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "rejection": null, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "complete", "submission": { "message_identification": "20250308723260130GT4LAKENDXBHQCZDWS", "submitted_at": "2020-01-31T23:59:59Z" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "fednow_transfer", "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a", "unstructured_remittance_information": "Invoice 29582" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/fednow_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "FedNow Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "FedNow Transfer Lists" }, "file": { "additionalProperties": true, "description": "Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.", "example": { "created_at": "2020-01-31T23:59:59Z", "description": "2022-05 statement for checking account", "direction": "from_increase", "filename": "statement.pdf", "id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "mime_type": "application/pdf", "purpose": "increase_statement", "type": "file" }, "properties": { "created_at": { "description": "The time the File was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the File.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "direction": { "description": "Whether the File was generated by Increase or by you and sent to Increase.", "enum": [ "to_increase", "from_increase" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This File was sent by you to Increase.", "This File was generated by Increase." ] }, "filename": { "description": "The filename that was provided upon upload or generated by Increase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The File's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "mime_type": { "description": "The MIME type of the file.", "type": "string", "x-documentation-priority": "default" }, "purpose": { "description": "What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "card_dispute_attachment", "check_image_front", "check_image_back", "processed_check_image_front", "processed_check_image_back", "mailed_check_image", "check_attachment", "check_voucher_image", "check_signature", "inbound_mail_item", "form_1099_int", "form_1099_misc", "form_ss_4", "identity_document", "increase_statement", "loan_application_supplemental_document", "other", "trust_formation_document", "digital_wallet_artwork", "digital_wallet_app_icon", "physical_card_front", "physical_card_back", "physical_card_carrier", "document_request", "entity_supplemental_document", "export", "fee_statement", "unusual_activity_report_attachment", "deposit_account_control_agreement", "proof_of_authorization_request_submission", "account_verification_letter", "funding_instructions", "hold_harmless_letter" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A file to be attached to a Card Dispute.", "An image of the front of a check, used for check deposits.", "An image of the back of a check, used for check deposits.", "An image of the front of a deposited check after processing by Increase and submission to the Federal Reserve.", "An image of the back of a deposited check after processing by Increase and submission to the Federal Reserve.", "An image of a check that was mailed to a recipient.", "A document to be printed on an additional page and mailed with a check that you've requested Increase print. This must be a PDF whose pages are all US letter size and all have the same orientation.", "An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.", "A signature image to be printed on a check. This must be a 1320x120 pixel PNG.", "A scanned mail item sent to Increase.", "IRS Form 1099-INT.", "IRS Form 1099-MISC.", "IRS Form SS-4.", "An image of a government-issued ID.", "A statement generated by Increase.", "A supplemental document for a Loan Application.", "A file purpose not covered by any of the other cases.", "A legal document forming a trust.", "A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.", "An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.", "A card image to be printed on the front of a physical card. This must be a 2100x1344 pixel PNG with no other color but black.", "The image to be printed on the back of a physical card.", "An image representing the entirety of the carrier used for a physical card. This must be a 2550x3300 pixel PNG with no other color but black.", "A document requested by Increase.", "A supplemental document associated an an Entity.", "The results of an Export you requested via the dashboard or API.", "A fee statement.", "An attachment to an Unusual Activity Report.", "A document granting another entity access to the funds into your account.", "A file containing additional evidence for a Proof of Authorization Request Submission.", "An account verification letter.", "Funding instructions.", "A Hold Harmless Letter." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `file`.", "enum": [ "file" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "created_at", "id", "purpose", "description", "direction", "mime_type", "filename", "idempotency_key" ], "title": "File", "type": "object", "x-event-categories": [ "file.created" ], "x-tag": "Files", "x-title-plural": "Files" }, "file_link": { "additionalProperties": false, "description": "File Links let you generate a URL that can be used to download a File.", "example": { "created_at": "2020-01-31T23:59:59Z", "expires_at": "2020-01-31T23:59:59Z", "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "file_link_roapsuicj7kp1lzyus04", "idempotency_key": null, "type": "file_link", "unauthenticated_url": "https://example.com/file.pdf" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Link was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "expires_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Link will expire.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File the File Link points to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "id": { "description": "The File Link identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "File Links" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `file_link`.", "enum": [ "file_link" ], "type": "string", "x-documentation-priority": "default" }, "unauthenticated_url": { "description": "A URL where the File can be downloaded. The URL will expire after the `expires_at` time. This URL is unauthenticated and can be used to download the File without an Increase API key.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "expires_at", "unauthenticated_url", "created_at", "file_id", "idempotency_key" ], "title": "File Link", "type": "object", "x-event-categories": [], "x-tag": "File Links", "x-title-plural": "File Links" }, "file_list": { "additionalProperties": true, "description": "A list of File objects.", "example": { "data": [ { "created_at": "2020-01-31T23:59:59Z", "description": "2022-05 statement for checking account", "direction": "from_increase", "filename": "statement.pdf", "id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "mime_type": "application/pdf", "purpose": "increase_statement", "type": "file" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/file" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "File List", "type": "object", "x-event-categories": [], "x-title-plural": "File Lists" }, "group": { "additionalProperties": false, "description": "Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth [here](https://increase.com/documentation/oauth).", "example": { "created_at": "2020-01-31T23:59:59Z", "id": "group_1g4mhziu6kvrs3vz35um", "type": "group" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Group identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Groups" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `group`.", "enum": [ "group" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "created_at", "id" ], "title": "Group", "type": "object", "x-event-categories": [], "x-tag": "Groups", "x-title-plural": "Groups" }, "inbound_ach_transfer": { "additionalProperties": true, "description": "An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.", "example": { "acceptance": { "accepted_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "addenda": null, "amount": 100, "automatically_resolves_at": "2020-01-31T23:59:59Z", "created_at": "2020-01-31T23:59:59Z", "decline": null, "direction": "credit", "effective_date": "2023-04-02", "id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "international_addenda": null, "notification_of_change": null, "originator_company_descriptive_date": "230401", "originator_company_discretionary_data": "WEB AUTOPAY", "originator_company_entry_description": "INVOICE 2468", "originator_company_id": "0987654321", "originator_company_name": "PAYROLL COMPANY", "originator_routing_number": "101050001", "receiver_id_number": null, "receiver_name": "Ian Crease", "settlement": { "settled_at": "2020-01-31T23:59:59Z", "settlement_schedule": "same_day" }, "standard_entry_class_code": "internet_initiated", "status": "accepted", "trace_number": "021000038461022", "transfer_return": null, "type": "inbound_ach_transfer" }, "properties": { "acceptance": { "additionalProperties": false, "description": "If your transfer is accepted, this will contain details of the acceptance.", "properties": { "accepted_at": { "description": "The time at which the transfer was accepted.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The id of the transaction for the accepted transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "accepted_at", "transaction_id" ], "title": "Inbound ACH Transfer Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Acceptances", "nullable": true }, "account_id": { "description": "The Account to which the transfer belongs.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number_id": { "description": "The identifier of the Account Number to which this transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "addenda": { "additionalProperties": false, "description": "Additional information sent from the originator.", "properties": { "category": { "description": "The type of addendum.", "enum": [ "freeform" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unstructured addendum." ] }, "freeform": { "additionalProperties": false, "description": "Unstructured `payment_related_information` passed through by the originator.", "properties": { "entries": { "description": "Each entry represents an addendum received from the originator.", "items": { "additionalProperties": false, "properties": { "payment_related_information": { "description": "The payment related information passed in the addendum.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "payment_related_information" ], "title": "Inbound ACH Transfer Addenda Freeform EntriesElement", "type": "object", "x-event-categories": [], "x-title-plural": "EntriesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "entries" ], "title": "Inbound ACH Transfer Addenda Freeform", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Freeforms", "nullable": true } }, "required": [ "category", "freeform" ], "title": "Inbound ACH Transfer Addenda", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addendas", "nullable": true }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "automatically_resolves_at": { "description": "The time at which the transfer will be automatically resolved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound ACH transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "decline": { "additionalProperties": false, "description": "If your transfer is declined, this will contain details of the decline.", "properties": { "declined_at": { "description": "The time at which the transfer was declined.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "declined_transaction_id": { "description": "The id of the transaction for the declined transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "reason": { "description": "The reason for the transfer decline.", "enum": [ "ach_route_canceled", "ach_route_disabled", "breaches_limit", "entity_not_active", "group_locked", "transaction_not_allowed", "returned_per_odfi_request", "user_initiated", "insufficient_funds", "authorization_revoked_by_customer", "payment_stopped", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "beneficiary_or_account_holder_deceased", "credit_entry_refused_by_receiver", "duplicate_entry", "corporate_customer_advised_not_authorized" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "The transaction would cause an Increase limit to be exceeded.", "The account's entity is not active.", "Your account is inactive.", "The transaction is not allowed per Increase's terms.", "The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.", "Your integration declined this transfer via the API.", "Your account contains insufficient funds.", "The customer no longer authorizes this transaction.", "The customer asked for the payment to be stopped.", "The customer advises that the debit was unauthorized.", "The payee is deceased.", "The account holder is deceased.", "The customer refused a credit entry.", "The account holder identified this transaction as a duplicate.", "The corporate customer no longer authorizes this transaction." ] } }, "required": [ "reason", "declined_at", "declined_transaction_id" ], "title": "Inbound ACH Transfer Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Declines", "nullable": true }, "direction": { "description": "The direction of the transfer.", "enum": [ "credit", "debit" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Credit", "Debit" ] }, "effective_date": { "description": "The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The inbound ACH transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" }, "international_addenda": { "additionalProperties": false, "description": "If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.", "example": { "destination_country_code": "US", "destination_currency_code": "USD", "foreign_exchange_indicator": "fixed_to_fixed", "foreign_exchange_reference": null, "foreign_exchange_reference_indicator": "blank", "foreign_payment_amount": 199, "foreign_trace_number": null, "international_transaction_type_code": "internet_initiated", "originating_currency_code": "USD", "originating_depository_financial_institution_branch_country": "US", "originating_depository_financial_institution_id": "091000019", "originating_depository_financial_institution_id_qualifier": "national_clearing_system_number", "originating_depository_financial_institution_name": "WELLS FARGO BANK", "originator_city": "BERLIN", "originator_country": "DE", "originator_identification": "770510487A", "originator_name": "BERGHAIN", "originator_postal_code": "50825", "originator_state_or_province": null, "originator_street_address": "Ruedersdorferstr. 7", "payment_related_information": null, "payment_related_information2": null, "receiver_city": "BEVERLY HILLS", "receiver_country": "US", "receiver_identification_number": "1018790279274", "receiver_postal_code": "90210", "receiver_state_or_province": "CA", "receiver_street_address": "123 FAKE ST", "receiving_company_or_individual_name": "IAN CREASE", "receiving_depository_financial_institution_country": "US", "receiving_depository_financial_institution_id": "101050001", "receiving_depository_financial_institution_id_qualifier": "national_clearing_system_number", "receiving_depository_financial_institution_name": "BLUE RIDGE BANK, NATIONAL ASSOCIATI" }, "properties": { "destination_country_code": { "description": "The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the destination country.", "type": "string", "x-documentation-priority": "default" }, "destination_currency_code": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the destination bank account.", "type": "string", "x-documentation-priority": "default" }, "foreign_exchange_indicator": { "description": "A description of how the foreign exchange rate was calculated.", "enum": [ "fixed_to_variable", "variable_to_fixed", "fixed_to_fixed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The originator chose an amount in their own currency. The settled amount in USD was converted using the exchange rate.", "The originator chose an amount to settle in USD. The originator's amount was variable; known only after the foreign exchange conversion.", "The amount was originated and settled as a fixed amount in USD. There is no foreign exchange conversion." ] }, "foreign_exchange_reference": { "description": "Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a reference to a well-known rate.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "foreign_exchange_reference_indicator": { "description": "An instruction of how to interpret the `foreign_exchange_reference` field for this Transaction.", "enum": [ "foreign_exchange_rate", "foreign_exchange_reference_number", "blank" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The ACH file contains a foreign exchange rate.", "The ACH file contains a reference to a well-known foreign exchange rate.", "There is no foreign exchange for this transfer, so the `foreign_exchange_reference` field is blank." ] }, "foreign_payment_amount": { "description": "The amount in the minor unit of the foreign payment currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "foreign_trace_number": { "description": "A reference number in the foreign banking infrastructure.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "international_transaction_type_code": { "description": "The type of transfer. Set by the originator.", "enum": [ "annuity", "business_or_commercial", "deposit", "loan", "miscellaneous", "mortgage", "pension", "remittance", "rent_or_lease", "salary_or_payroll", "tax", "accounts_receivable", "back_office_conversion", "machine_transfer", "point_of_purchase", "point_of_sale", "represented_check", "shared_network_transaction", "telphone_initiated", "internet_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Sent as `ANN` in the Nacha file.", "Sent as `BUS` in the Nacha file.", "Sent as `DEP` in the Nacha file.", "Sent as `LOA` in the Nacha file.", "Sent as `MIS` in the Nacha file.", "Sent as `MOR` in the Nacha file.", "Sent as `PEN` in the Nacha file.", "Sent as `REM` in the Nacha file.", "Sent as `RLS` in the Nacha file.", "Sent as `SAL` in the Nacha file.", "Sent as `TAX` in the Nacha file.", "Sent as `ARC` in the Nacha file.", "Sent as `BOC` in the Nacha file.", "Sent as `MTE` in the Nacha file.", "Sent as `POP` in the Nacha file.", "Sent as `POS` in the Nacha file.", "Sent as `RCK` in the Nacha file.", "Sent as `SHR` in the Nacha file.", "Sent as `TEL` in the Nacha file.", "Sent as `WEB` in the Nacha file." ] }, "originating_currency_code": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the originating bank account.", "type": "string", "x-documentation-priority": "default" }, "originating_depository_financial_institution_branch_country": { "description": "The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originating branch country.", "type": "string", "x-documentation-priority": "default" }, "originating_depository_financial_institution_id": { "description": "An identifier for the originating bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number.", "type": "string", "x-documentation-priority": "default" }, "originating_depository_financial_institution_id_qualifier": { "description": "An instruction of how to interpret the `originating_depository_financial_institution_id` field for this Transaction.", "enum": [ "national_clearing_system_number", "bic_code", "iban" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number.", "The SWIFT Bank Identifier Code (BIC) of the bank.", "An International Bank Account Number." ] }, "originating_depository_financial_institution_name": { "description": "The name of the originating bank. Sometimes this will refer to an American bank and obscure the correspondent foreign bank.", "type": "string", "x-documentation-priority": "default" }, "originator_city": { "description": "A portion of the originator address. This may be incomplete.", "type": "string", "x-documentation-priority": "default" }, "originator_country": { "description": "A portion of the originator address. The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originator country.", "type": "string", "x-documentation-priority": "default" }, "originator_identification": { "description": "An identifier for the originating company. This is generally stable across multiple ACH transfers.", "type": "string", "x-documentation-priority": "default" }, "originator_name": { "description": "Either the name of the originator or an intermediary money transmitter.", "type": "string", "x-documentation-priority": "default" }, "originator_postal_code": { "description": "A portion of the originator address. This may be incomplete.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_state_or_province": { "description": "A portion of the originator address. This may be incomplete.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_street_address": { "description": "A portion of the originator address. This may be incomplete.", "type": "string", "x-documentation-priority": "default" }, "payment_related_information": { "description": "A description field set by the originator.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "payment_related_information2": { "description": "A description field set by the originator.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_city": { "description": "A portion of the receiver address. This may be incomplete.", "type": "string", "x-documentation-priority": "default" }, "receiver_country": { "description": "A portion of the receiver address. The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiver country.", "type": "string", "x-documentation-priority": "default" }, "receiver_identification_number": { "description": "An identification number the originator uses for the receiver.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_postal_code": { "description": "A portion of the receiver address. This may be incomplete.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_state_or_province": { "description": "A portion of the receiver address. This may be incomplete.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_street_address": { "description": "A portion of the receiver address. This may be incomplete.", "type": "string", "x-documentation-priority": "default" }, "receiving_company_or_individual_name": { "description": "The name of the receiver of the transfer. This is not verified by Increase.", "type": "string", "x-documentation-priority": "default" }, "receiving_depository_financial_institution_country": { "description": "The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiving bank country.", "type": "string", "x-documentation-priority": "default" }, "receiving_depository_financial_institution_id": { "description": "An identifier for the receiving bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number.", "type": "string", "x-documentation-priority": "default" }, "receiving_depository_financial_institution_id_qualifier": { "description": "An instruction of how to interpret the `receiving_depository_financial_institution_id` field for this Transaction.", "enum": [ "national_clearing_system_number", "bic_code", "iban" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number.", "The SWIFT Bank Identifier Code (BIC) of the bank.", "An International Bank Account Number." ] }, "receiving_depository_financial_institution_name": { "description": "The name of the receiving bank, as set by the sending financial institution.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "foreign_exchange_indicator", "foreign_exchange_reference_indicator", "foreign_exchange_reference", "destination_country_code", "destination_currency_code", "foreign_payment_amount", "foreign_trace_number", "international_transaction_type_code", "originating_currency_code", "originating_depository_financial_institution_name", "originating_depository_financial_institution_id_qualifier", "originating_depository_financial_institution_id", "originating_depository_financial_institution_branch_country", "originator_name", "originator_street_address", "originator_city", "originator_state_or_province", "originator_postal_code", "originator_country", "originator_identification", "payment_related_information", "payment_related_information2", "receiver_identification_number", "receiver_street_address", "receiver_city", "receiver_state_or_province", "receiver_country", "receiver_postal_code", "receiving_company_or_individual_name", "receiving_depository_financial_institution_name", "receiving_depository_financial_institution_id_qualifier", "receiving_depository_financial_institution_id", "receiving_depository_financial_institution_country" ], "title": "Inbound ACH Transfer Inbound ACH Transfer International Addendum", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound ACH Transfer International Addendums", "nullable": true }, "notification_of_change": { "additionalProperties": false, "description": "If you initiate a notification of change in response to the transfer, this will contain its details.", "properties": { "updated_account_number": { "description": "The new account number provided in the notification of change.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "updated_routing_number": { "description": "The new routing number provided in the notification of change.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "updated_account_number", "updated_routing_number" ], "title": "Inbound ACH Transfer NotificationOfChange", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "NotificationOfChanges", "nullable": true }, "originator_company_descriptive_date": { "description": "The descriptive date of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_company_discretionary_data": { "description": "The additional information included with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_company_entry_description": { "description": "The description of the transfer.", "type": "string", "x-documentation-priority": "default" }, "originator_company_id": { "description": "The id of the company that initiated the transfer.", "type": "string", "x-documentation-priority": "default" }, "originator_company_name": { "description": "The name of the company that initiated the transfer.", "type": "string", "x-documentation-priority": "default" }, "originator_routing_number": { "description": "The American Banking Association (ABA) routing number of the bank originating the transfer.", "type": "string", "x-documentation-priority": "default" }, "receiver_id_number": { "description": "The id of the receiver of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_name": { "description": "The name of the receiver of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "settlement": { "additionalProperties": false, "description": "A subhash containing information about when and how the transfer settled at the Federal Reserve.", "properties": { "settled_at": { "description": "When the funds for this transfer settle at the recipient bank at the Federal Reserve.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "settlement_schedule": { "description": "The settlement schedule this transfer follows.", "enum": [ "same_day", "future_dated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is expected to settle same-day.", "The transfer is expected to settle on a future date." ] } }, "required": [ "settled_at", "settlement_schedule" ], "title": "Inbound ACH Transfer Settlement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Settlements" }, "standard_entry_class_code": { "description": "The Standard Entry Class (SEC) code of the transfer.", "enum": [ "corporate_credit_or_debit", "corporate_trade_exchange", "prearranged_payments_and_deposit", "internet_initiated", "point_of_sale", "telephone_initiated", "customer_initiated", "accounts_receivable", "machine_transfer", "shared_network_transaction", "represented_check", "back_office_conversion", "point_of_purchase", "check_truncation", "destroyed_check", "international_ach_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Corporate Credit and Debit (CCD).", "Corporate Trade Exchange (CTX).", "Prearranged Payments and Deposits (PPD).", "Internet Initiated (WEB).", "Point of Sale (POS).", "Telephone Initiated (TEL).", "Customer Initiated (CIE).", "Accounts Receivable (ARC).", "Machine Transfer (MTE).", "Shared Network Transaction (SHR).", "Represented Check (RCK).", "Back Office Conversion (BOC).", "Point of Purchase (POP).", "Check Truncation (TRC).", "Destroyed Check (XCK).", "International ACH Transaction (IAT)." ] }, "status": { "description": "The status of the transfer.", "enum": [ "pending", "declined", "accepted", "returned" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken.", "The Inbound ACH Transfer has been declined.", "The Inbound ACH Transfer is accepted.", "The Inbound ACH Transfer has been returned." ] }, "trace_number": { "description": "A 15 digit number set by the sending bank and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer. ACH trace numbers are not unique, but are [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).", "type": "string", "x-documentation-priority": "default" }, "transfer_return": { "additionalProperties": false, "description": "If your transfer is returned, this will contain details of the return.", "properties": { "reason": { "description": "The reason for the transfer return.", "enum": [ "insufficient_funds", "returned_per_odfi_request", "authorization_revoked_by_customer", "payment_stopped", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "beneficiary_or_account_holder_deceased", "credit_entry_refused_by_receiver", "duplicate_entry", "corporate_customer_advised_not_authorized" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01.", "The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request. The Nacha return code is R06.", "The customer no longer authorizes this transaction. The Nacha return code is R07.", "The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.", "The customer advises that the debit was unauthorized. The Nacha return code is R10.", "The payee is deceased. The Nacha return code is R14.", "The account holder is deceased. The Nacha return code is R15.", "The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.", "The account holder identified this transaction as a duplicate. The Nacha return code is R24.", "The corporate customer no longer authorizes this transaction. The Nacha return code is R29." ] }, "returned_at": { "description": "The time at which the transfer was returned.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The id of the transaction for the returned transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "reason", "returned_at", "transaction_id" ], "title": "Inbound ACH Transfer TransferReturn", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "TransferReturns", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_ach_transfer`.", "enum": [ "inbound_ach_transfer" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "amount", "account_id", "account_number_id", "direction", "status", "created_at", "originator_company_name", "originator_company_descriptive_date", "originator_company_discretionary_data", "originator_company_entry_description", "originator_company_id", "originator_routing_number", "receiver_id_number", "receiver_name", "trace_number", "effective_date", "standard_entry_class_code", "settlement", "automatically_resolves_at", "addenda", "acceptance", "decline", "transfer_return", "notification_of_change", "international_addenda" ], "title": "Inbound ACH Transfer", "type": "object", "x-event-categories": [ "inbound_ach_transfer.created", "inbound_ach_transfer.updated" ], "x-tag": "Inbound ACH Transfers", "x-title-plural": "Inbound ACH Transfers" }, "inbound_ach_transfer_list": { "additionalProperties": true, "description": "A list of Inbound ACH Transfer objects.", "example": { "data": [ { "acceptance": { "accepted_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "addenda": null, "amount": 100, "automatically_resolves_at": "2020-01-31T23:59:59Z", "created_at": "2020-01-31T23:59:59Z", "decline": null, "direction": "credit", "effective_date": "2023-04-02", "id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "international_addenda": null, "notification_of_change": null, "originator_company_descriptive_date": "230401", "originator_company_discretionary_data": "WEB AUTOPAY", "originator_company_entry_description": "INVOICE 2468", "originator_company_id": "0987654321", "originator_company_name": "PAYROLL COMPANY", "originator_routing_number": "101050001", "receiver_id_number": null, "receiver_name": "Ian Crease", "settlement": { "settled_at": "2020-01-31T23:59:59Z", "settlement_schedule": "same_day" }, "standard_entry_class_code": "internet_initiated", "status": "accepted", "trace_number": "021000038461022", "transfer_return": null, "type": "inbound_ach_transfer" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_ach_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound ACH Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound ACH Transfer Lists" }, "inbound_ach_transfer_return_intention": { "additionalProperties": true, "description": "An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase.", "example": { "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" }, "properties": { "inbound_ach_transfer_id": { "description": "The ID of the Inbound ACH Transfer that is being returned.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" } }, "required": [ "inbound_ach_transfer_id" ], "title": "Inbound ACH Transfer Return Intention", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound ACH Transfer Return Intentions" }, "inbound_card_authorization_simulation_result": { "additionalProperties": false, "description": "The results of a Card Authorization simulation.", "example": { "declined_transaction": null, "pending_transaction": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "completed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "held_amount": 100, "id": "pending_transaction_k1sfetcau2qbvjbzgju4", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "card_authorization": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "category": "card_authorization" }, "status": "pending", "type": "pending_transaction" }, "type": "inbound_card_authorization_simulation_result" }, "properties": { "declined_transaction": { "description": "If the authorization attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: card_decline`.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/declined_transaction" } ], "nullable": true }, "pending_transaction": { "description": "If the authorization attempt succeeds, this will contain the resulting Pending Transaction object. The Pending Transaction's `source` will be of `category: card_authorization`.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/pending_transaction" } ], "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_card_authorization_simulation_result`.", "enum": [ "inbound_card_authorization_simulation_result" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "pending_transaction", "declined_transaction" ], "title": "Inbound Card Authorization Simulation Result", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Card Authorization Simulation Results" }, "inbound_card_validation": { "additionalProperties": true, "description": "Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid.", "example": { "actioner": "increase", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": { "amount": 10, "currency": "USD" }, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "id": "card_validation_yi4e59jiaz6n9hx8tczv", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "physical_card_id": null, "real_time_decision_id": null, "scheme_fees": [ { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" } ], "terminal_id": "RCN5VNXS", "type": "inbound_card_validation", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "properties": { "actioner": { "description": "Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.", "enum": [ "user", "increase", "network" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This object was actioned by the user through a real-time decision.", "This object was actioned by Increase without user intervention.", "This object was actioned by the network, through stand-in processing." ] }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Inbound Card Validation AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Inbound Card Validation AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "card_payment_id": { "description": "The ID of the Card Payment this transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "id": { "description": "The Card Validation identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Card Validations" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Inbound Card Validation NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Inbound Card Validation NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Inbound Card Validation NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Inbound Card Validation NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "real_time_decision_id": { "description": "The identifier of the Real-Time Decision sent to approve or decline this transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions", "nullable": true }, "scheme_fees": { "description": "The scheme fees associated with this card validation.", "items": { "additionalProperties": false, "example": { "amount": "0.137465", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "fee_type": "visa_corporate_acceptance_fee", "fixed_component": null, "variable_rate": "0.0002" }, "properties": { "amount": { "description": "The fee amount given as a string containing a decimal number.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_type": { "description": "The type of fee being assessed.", "enum": [ "visa_international_service_assessment_single_currency", "visa_international_service_assessment_cross_currency", "visa_authorization_domestic_point_of_sale", "visa_authorization_international_point_of_sale", "visa_authorization_canada_point_of_sale", "visa_authorization_reversal_point_of_sale", "visa_authorization_reversal_international_point_of_sale", "visa_authorization_address_verification_service", "visa_advanced_authorization", "visa_message_transmission", "visa_account_verification_domestic", "visa_account_verification_international", "visa_account_verification_canada", "visa_corporate_acceptance_fee", "visa_consumer_debit_acceptance_fee", "visa_business_debit_acceptance_fee", "visa_purchasing_acceptance_fee", "visa_purchase_domestic", "visa_purchase_international", "visa_credit_purchase_token", "visa_debit_purchase_token", "visa_clearing_transmission", "visa_direct_authorization", "visa_direct_transaction_domestic", "visa_service_commercial_credit", "visa_advertising_service_commercial_credit", "visa_community_growth_acceleration_program", "visa_processing_guarantee_commercial_credit", "pulse_switch_fee" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.", "International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.", "Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.", "A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.", "Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).", "Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.", "Activity, per inquiry, related to the domestic Issuer for Account Number Verification.", "Activity, per inquiry, related to the international Issuer for Account Number Verification.", "Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.", "The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.", "The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.", "The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.", "Activity and fees for the processing of a sales draft original for a purchase transaction.", "Activity and fees for the processing of an international sales draft original for a purchase transaction.", "Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.", "A per transaction fee assessed for Base II financial draft - Issuer.", "Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.", "Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.", "Issuer card service fee for Commercial Credit cards.", "Issuer Advertising Service Fee for Commercial Credit cards.", "Issuer Community Growth Acceleration Program Fee.", "Issuer Processing Guarantee for Commercial Credit cards.", "Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network." ] }, "fixed_component": { "description": "The fixed component of the fee, if applicable, given in major units of the fee amount.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true }, "variable_rate": { "description": "The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "created_at", "amount", "currency", "fee_type", "variable_rate", "fixed_component" ], "title": "Inbound Card Validation Card Scheme Fee", "type": "object", "x-event-categories": [], "x-title-plural": "Card Scheme Fees" }, "type": "array", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_card_validation`.", "enum": [ "inbound_card_validation" ], "type": "string", "x-documentation-priority": "default" }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Inbound Card Validation Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Inbound Card Validation Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Inbound Card Validation Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Inbound Card Validation Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "type", "id", "card_payment_id", "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "currency", "real_time_decision_id", "actioner", "scheme_fees" ], "title": "Inbound Card Validation", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Card Validations" }, "inbound_check_adjustment": { "additionalProperties": true, "description": "An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21.", "example": { "adjusted_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "amount": 1750, "reason": "late_return" }, "properties": { "adjusted_transaction_id": { "description": "The ID of the transaction that was adjusted.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "amount": { "description": "The amount of the check adjustment.", "type": "integer", "x-documentation-priority": "default" }, "reason": { "description": "The reason for the adjustment.", "enum": [ "late_return", "wrong_payee_credit", "adjusted_amount", "non_conforming_item", "paid" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The return was initiated too late and the receiving institution has responded with a Late Return Claim.", "The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.", "The check was deposited with a different amount than what was written on the check.", "The recipient was not able to process the check. This usually happens for e.g., low quality images.", "The check has already been deposited elsewhere and so this is a duplicate." ] } }, "required": [ "adjusted_transaction_id", "amount", "reason" ], "title": "Inbound Check Adjustment", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Check Adjustments" }, "inbound_check_deposit": { "additionalProperties": false, "description": "Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.", "example": { "accepted_at": "2020-01-31T23:59:59Z", "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "adjustments": [], "amount": 1000, "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "bank_of_first_deposit_routing_number": "101050001", "check_number": "123", "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "declined_at": null, "declined_transaction_id": null, "deposit_return": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "payee_name_analysis": "name_matches", "status": "accepted", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "inbound_check_deposit" }, "properties": { "accepted_at": { "description": "If the Inbound Check Deposit was accepted, the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "account_id": { "description": "The Account the check is being deposited against.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number_id": { "description": "The Account Number the check is being deposited against.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers", "nullable": true }, "adjustments": { "description": "If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.", "items": { "additionalProperties": false, "properties": { "adjusted_at": { "description": "The time at which the return adjustment was received.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The amount of the adjustment.", "type": "integer", "x-documentation-priority": "default" }, "reason": { "description": "The reason for the adjustment.", "enum": [ "late_return", "wrong_payee_credit" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The return was initiated too late and the receiving institution has responded with a Late Return Claim.", "The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit." ] }, "transaction_id": { "description": "The id of the transaction for the adjustment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "adjusted_at", "transaction_id", "reason", "amount" ], "title": "Inbound Check Deposit AdjustmentsElement", "type": "object", "x-event-categories": [], "x-title-plural": "AdjustmentsElements" }, "type": "array", "x-documentation-priority": "default" }, "amount": { "description": "The deposited amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "back_image_file_id": { "description": "The ID for the File containing the image of the back of the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "bank_of_first_deposit_routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "check_number": { "description": "The check number printed on the check being deposited.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "check_transfer_id": { "description": "If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit was attempted.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "declined_at": { "description": "If the Inbound Check Deposit was declined, the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "declined_transaction_id": { "description": "If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions", "nullable": true }, "deposit_return": { "additionalProperties": false, "description": "If you requested a return of this deposit, this will contain details of the return.", "properties": { "reason": { "description": "The reason the deposit was returned.", "enum": [ "altered_or_fictitious", "not_authorized", "duplicate_presentment", "endorsement_missing", "endorsement_irregular", "refer_to_maker" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check was altered or fictitious.", "The check was not authorized.", "The check was a duplicate presentment.", "The check was not endorsed.", "The check was not endorsed by the payee.", "The maker of the check requested its return." ] }, "returned_at": { "description": "The time at which the deposit was returned.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The id of the transaction for the returned deposit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "returned_at", "transaction_id", "reason" ], "title": "Inbound Check Deposit DepositReturn", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "DepositReturns", "nullable": true }, "front_image_file_id": { "description": "The ID for the File containing the image of the front of the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "id": { "description": "The deposit's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits" }, "payee_name_analysis": { "description": "Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.", "enum": [ "name_matches", "does_not_match", "not_evaluated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The details on the check match the recipient name of the check transfer.", "The details on the check do not match the recipient name of the check transfer.", "The payee name analysis was not evaluated." ] }, "status": { "description": "The status of the Inbound Check Deposit.", "enum": [ "pending", "accepted", "declined", "returned", "requires_attention" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Inbound Check Deposit is pending.", "The Inbound Check Deposit was accepted.", "The Inbound Check Deposit was rejected.", "The Inbound Check Deposit was returned.", "The Inbound Check Deposit requires attention from an Increase operator." ] }, "transaction_id": { "description": "If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_check_deposit`.", "enum": [ "inbound_check_deposit" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "amount", "created_at", "currency", "status", "account_id", "account_number_id", "check_transfer_id", "front_image_file_id", "back_image_file_id", "transaction_id", "declined_transaction_id", "deposit_return", "adjustments", "accepted_at", "declined_at", "bank_of_first_deposit_routing_number", "check_number", "payee_name_analysis" ], "title": "Inbound Check Deposit", "type": "object", "x-event-categories": [ "inbound_check_deposit.created", "inbound_check_deposit.updated" ], "x-tag": "Inbound Check Deposits", "x-title-plural": "Inbound Check Deposits" }, "inbound_check_deposit_list": { "additionalProperties": true, "description": "A list of Inbound Check Deposit objects.", "example": { "data": [ { "accepted_at": "2020-01-31T23:59:59Z", "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "adjustments": [], "amount": 1000, "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "bank_of_first_deposit_routing_number": "101050001", "check_number": "123", "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "declined_at": null, "declined_transaction_id": null, "deposit_return": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "payee_name_analysis": "name_matches", "status": "accepted", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "inbound_check_deposit" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_check_deposit" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound Check Deposit List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Check Deposit Lists" }, "inbound_check_deposit_return_intention": { "additionalProperties": true, "description": "An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned.", "example": { "inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "transfer_id": "check_transfer_30b43acfu9vw8fyc4f5" }, "properties": { "inbound_check_deposit_id": { "description": "The ID of the Inbound Check Deposit that is being returned.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits" }, "transfer_id": { "description": "The identifier of the Check Transfer object that was deposited.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers", "nullable": true } }, "required": [ "inbound_check_deposit_id", "transfer_id" ], "title": "Inbound Check Deposit Return Intention", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Check Deposit Return Intentions" }, "inbound_digital_wallet_token_request_simulation_result": { "additionalProperties": false, "description": "The results of a Digital Wallet Token simulation.", "example": { "decline_reason": null, "digital_wallet_token_id": "digital_wallet_token_izi62go3h51p369jrie0", "type": "inbound_digital_wallet_token_request_simulation_result" }, "properties": { "decline_reason": { "description": "If the simulated tokenization attempt was declined, this field contains details as to why.", "enum": [ "card_not_active", "no_verification_method", "webhook_timed_out", "webhook_declined" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card is not active.", "The card does not have a two-factor authentication method.", "Your webhook timed out when evaluating the token provisioning attempt.", "Your webhook declined the token provisioning attempt." ], "nullable": true }, "digital_wallet_token_id": { "description": "If the simulated tokenization attempt was accepted, this field contains the id of the Digital Wallet Token that was created.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_digital_wallet_token_request_simulation_result`.", "enum": [ "inbound_digital_wallet_token_request_simulation_result" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "decline_reason", "digital_wallet_token_id" ], "title": "Inbound Digital Wallet Token Request Simulation Result", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Digital Wallet Token Request Simulation Results" }, "inbound_fednow_transfer": { "additionalProperties": false, "description": "An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "confirmation": { "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "created_at": "2020-01-31T23:59:59Z", "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "decline": { "reason": "account_number_disabled", "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20", "status": "confirmed", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "inbound_fednow_transfer", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_id": { "description": "The Account to which the transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number_id": { "description": "The identifier of the Account Number to which this transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "confirmation": { "additionalProperties": true, "description": "If your transfer is confirmed, this will contain details of the confirmation.", "example": { "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "properties": { "transfer_id": { "description": "The identifier of the FedNow Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound FedNow Transfers" } }, "required": [ "transfer_id" ], "title": "Inbound FedNow Transfer Inbound FedNow Transfer Confirmation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound FedNow Transfer Confirmations", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creditor_name": { "description": "The name the sender of the transfer specified as the recipient of the transfer.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be \"USD\" for a FedNow transfer.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor_account_number": { "description": "The account number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name provided by the sender of the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The routing number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "decline": { "additionalProperties": true, "description": "If your transfer is declined, this will contain details of the decline.", "example": { "reason": "account_number_disabled", "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "properties": { "reason": { "description": "Why the transfer was declined.", "enum": [ "account_number_canceled", "account_number_disabled", "account_restricted", "group_locked", "entity_not_active", "fednow_not_enabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "Your account is restricted.", "Your account is inactive.", "The account's entity is not active.", "Your account is not enabled to receive FedNow transfers." ] }, "transfer_id": { "description": "The identifier of the FedNow Transfer that led to this declined transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound FedNow Transfers" } }, "required": [ "reason", "transfer_id" ], "title": "Inbound FedNow Transfer Inbound FedNow Transfer Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound FedNow Transfer Declines", "nullable": true }, "id": { "description": "The inbound FedNow transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound FedNow Transfers" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_confirming", "timed_out", "confirmed", "declined", "requires_attention" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending confirmation.", "The transfer was not responded to in time.", "The transfer has been received successfully and is confirmed.", "The transfer has been declined.", "The transfer requires attention from an Increase operator." ] }, "transaction_id": { "description": "The identifier of the Transaction object created when the transfer was confirmed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_fednow_transfer`.", "enum": [ "inbound_fednow_transfer" ], "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Additional information included with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "type", "id", "amount", "currency", "creditor_name", "debtor_name", "debtor_account_number", "debtor_routing_number", "unstructured_remittance_information", "status", "account_id", "account_number_id", "created_at", "transaction_id", "decline", "confirmation" ], "title": "Inbound FedNow Transfer", "type": "object", "x-event-categories": [ "inbound_fednow_transfer.created", "inbound_fednow_transfer.updated" ], "x-tag": "Inbound FedNow Transfers", "x-title-plural": "Inbound FedNow Transfers" }, "inbound_fednow_transfer_list": { "additionalProperties": true, "description": "A list of Inbound FedNow Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "confirmation": { "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "created_at": "2020-01-31T23:59:59Z", "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "decline": { "reason": "account_number_disabled", "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20", "status": "confirmed", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "inbound_fednow_transfer", "unstructured_remittance_information": "Invoice 29582" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_fednow_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound FedNow Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound FedNow Transfer Lists" }, "inbound_funds_hold": { "additionalProperties": true, "description": "We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.", "example": { "amount": 100, "automatically_releases_at": "2020-01-31T23:59:59Z", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "held_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "released_at": null, "status": "held", "type": "inbound_funds_hold" }, "properties": { "amount": { "description": "The held amount in the minor unit of the account's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "automatically_releases_at": { "description": "When the hold will be released automatically. Certain conditions may cause it to be released before this time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "held_transaction_id": { "description": "The ID of the Transaction for which funds were held.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "pending_transaction_id": { "description": "The ID of the Pending Transaction representing the held funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "released_at": { "description": "When the hold was released (if it has been released).", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The status of the hold.", "enum": [ "held", "complete" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Funds are still being held.", "Funds have been released." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_funds_hold`.", "enum": [ "inbound_funds_hold" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "amount", "created_at", "currency", "automatically_releases_at", "released_at", "status", "held_transaction_id", "pending_transaction_id" ], "title": "Inbound Funds Hold", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Funds Holds" }, "inbound_mail_item": { "additionalProperties": true, "description": "Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.", "example": { "checks": [ { "amount": 1750, "back_file_id": "file_makxrc67oh9l6sg7w9yc", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "front_file_id": "file_makxrc67oh9l6sg7w9yc", "status": "deposited" }, { "amount": 1750, "back_file_id": "file_makxrc67oh9l6sg7w9yc", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "front_file_id": "file_makxrc67oh9l6sg7w9yc", "status": "deposited" } ], "created_at": "2020-01-31T23:59:59Z", "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_mail_item_q6rrg7mmqpplx80zceev", "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "lockbox_recipient_id": "lockbox_3xt21ok13q19advds4t5", "recipient_name": "Ian Crease", "rejection_reason": null, "status": "processed", "type": "inbound_mail_item" }, "properties": { "checks": { "description": "The checks in the mail item.", "items": { "$ref": "#/components/schemas/inbound_mail_item_check" }, "type": "array", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound Mail Item was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier for the File containing the scanned contents of the mail item.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "id": { "description": "The Inbound Mail Item identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Mail Items" }, "lockbox_address_id": { "description": "The identifier for the Lockbox Address that received this mail item.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" }, "lockbox_recipient_id": { "description": "The identifier for the Lockbox Recipient that received this mail item. For mail items that could not be routed to a Lockbox Recipient, this will be null.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients", "nullable": true }, "recipient_name": { "description": "The recipient name as written on the mail item.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "rejection_reason": { "description": "If the mail item has been rejected, why it was rejected.", "enum": [ "no_matching_lockbox", "no_check", "lockbox_not_active", "lockbox_address_not_active", "lockbox_recipient_not_active" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The mail item does not match any lockbox.", "The mail item does not contain a check.", "The Lockbox or its associated Account is not active.", "The Lockbox Address is not active.", "The Lockbox Recipient or its associated Account is not active." ], "nullable": true }, "status": { "description": "If the mail item has been processed.", "enum": [ "pending", "processed", "rejected" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The mail item is pending processing.", "The mail item has been processed.", "The mail item has been rejected." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_mail_item`.", "enum": [ "inbound_mail_item" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "recipient_name", "status", "rejection_reason", "file_id", "lockbox_recipient_id", "lockbox_address_id", "checks" ], "title": "Inbound Mail Item", "type": "object", "x-event-categories": [ "inbound_mail_item.created", "inbound_mail_item.updated" ], "x-tag": "Inbound Mail Items", "x-title-plural": "Inbound Mail Items" }, "inbound_mail_item_check": { "additionalProperties": false, "description": "Inbound Mail Item Checks represent the checks in an Inbound Mail Item.", "example": { "amount": 1750, "back_file_id": "file_makxrc67oh9l6sg7w9yc", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "front_file_id": "file_makxrc67oh9l6sg7w9yc", "status": "deposited" }, "properties": { "amount": { "description": "The amount of the check.", "type": "integer", "x-documentation-priority": "default" }, "back_file_id": { "description": "The identifier for the File containing the back of the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "check_deposit_id": { "description": "The identifier of the Check Deposit if this check was deposited.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits", "nullable": true }, "front_file_id": { "description": "The identifier for the File containing the front of the check.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "status": { "description": "The status of the Inbound Mail Item Check.", "enum": [ "pending", "deposited", "ignored" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check is pending processing.", "The check has been deposited.", "The check has been ignored." ], "nullable": true } }, "required": [ "amount", "status", "front_file_id", "back_file_id", "check_deposit_id" ], "title": "Inbound Mail Item Check", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Mail Item Checks" }, "inbound_mail_item_list": { "additionalProperties": true, "description": "A list of Inbound Mail Item objects.", "example": { "data": [ { "checks": [ { "amount": 1750, "back_file_id": "file_makxrc67oh9l6sg7w9yc", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "front_file_id": "file_makxrc67oh9l6sg7w9yc", "status": "deposited" }, { "amount": 1750, "back_file_id": "file_makxrc67oh9l6sg7w9yc", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "front_file_id": "file_makxrc67oh9l6sg7w9yc", "status": "deposited" } ], "created_at": "2020-01-31T23:59:59Z", "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_mail_item_q6rrg7mmqpplx80zceev", "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "lockbox_recipient_id": "lockbox_3xt21ok13q19advds4t5", "recipient_name": "Ian Crease", "rejection_reason": null, "status": "processed", "type": "inbound_mail_item" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_mail_item" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound Mail Item List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Mail Item Lists" }, "inbound_real_time_payments_transfer": { "additionalProperties": true, "description": "An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "confirmation": { "confirmed_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "created_at": "2020-01-31T23:59:59Z", "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "decline": null, "id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr", "status": "confirmed", "transaction_identification": "20220501234567891T1BSLZO01745013025", "type": "inbound_real_time_payments_transfer", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_id": { "description": "The Account to which the transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number_id": { "description": "The identifier of the Account Number to which this transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "confirmation": { "additionalProperties": false, "description": "If your transfer is confirmed, this will contain details of the confirmation.", "properties": { "confirmed_at": { "description": "The time at which the transfer was confirmed.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The id of the transaction for the confirmed transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "confirmed_at", "transaction_id" ], "title": "Inbound Real-Time Payments Transfer Confirmation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Confirmations", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creditor_name": { "description": "The name the sender of the transfer specified as the recipient of the transfer.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be \"USD\" for a Real-Time Payments transfer.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor_account_number": { "description": "The account number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name provided by the sender of the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The routing number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "decline": { "additionalProperties": false, "description": "If your transfer is declined, this will contain details of the decline.", "properties": { "declined_at": { "description": "The time at which the transfer was declined.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "declined_transaction_id": { "description": "The id of the transaction for the declined transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" }, "reason": { "description": "The reason for the transfer decline.", "enum": [ "account_number_canceled", "account_number_disabled", "account_restricted", "group_locked", "entity_not_active", "real_time_payments_not_enabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is canceled.", "The account number is disabled.", "Your account is restricted.", "Your account is inactive.", "The account's entity is not active.", "Your account is not enabled to receive Real-Time Payments transfers." ] } }, "required": [ "reason", "declined_at", "declined_transaction_id" ], "title": "Inbound Real-Time Payments Transfer Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Declines", "nullable": true }, "id": { "description": "The inbound Real-Time Payments transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Real-Time Payments Transfers" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_confirming", "timed_out", "confirmed", "declined" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending confirmation.", "The transfer was not responded to in time.", "The transfer has been received successfully and is confirmed.", "The transfer has been declined." ] }, "transaction_identification": { "description": "The Real-Time Payments network identification of the transfer.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer`.", "enum": [ "inbound_real_time_payments_transfer" ], "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Additional information included with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "type", "id", "amount", "currency", "creditor_name", "debtor_name", "debtor_account_number", "debtor_routing_number", "transaction_identification", "unstructured_remittance_information", "status", "account_id", "account_number_id", "created_at", "confirmation", "decline" ], "title": "Inbound Real-Time Payments Transfer", "type": "object", "x-event-categories": [ "inbound_real_time_payments_transfer.created", "inbound_real_time_payments_transfer.updated" ], "x-tag": "Inbound Real-Time Payments Transfers", "x-title-plural": "Inbound Real-Time Payments Transfers" }, "inbound_real_time_payments_transfer_list": { "additionalProperties": true, "description": "A list of Inbound Real-Time Payments Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "confirmation": { "confirmed_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "created_at": "2020-01-31T23:59:59Z", "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "decline": null, "id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr", "status": "confirmed", "transaction_identification": "20220501234567891T1BSLZO01745013025", "type": "inbound_real_time_payments_transfer", "unstructured_remittance_information": "Invoice 29582" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_real_time_payments_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound Real-Time Payments Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Real-Time Payments Transfer Lists" }, "inbound_wire_drawdown_request": { "additionalProperties": true, "description": "Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).", "example": { "amount": 10000, "created_at": "2020-01-31T23:59:59Z", "creditor_account_number": "987654321", "creditor_address_line1": "33 Liberty Street", "creditor_address_line2": "New York, NY, 10045", "creditor_address_line3": null, "creditor_name": "Ian Crease", "creditor_routing_number": "101050001", "currency": "USD", "debtor_address_line1": "33 Liberty Street", "debtor_address_line2": "New York, NY, 10045", "debtor_address_line3": null, "debtor_name": "Ian Crease", "end_to_end_identification": "Invoice 29582", "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e", "input_message_accountability_data": null, "instruction_identification": null, "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "type": "inbound_wire_drawdown_request", "unique_end_to_end_transaction_reference": null, "unstructured_remittance_information": null }, "properties": { "amount": { "description": "The amount being requested in cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire drawdown request was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creditor_account_number": { "description": "The creditor's account number.", "type": "string", "x-documentation-priority": "default" }, "creditor_address_line1": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_address_line2": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_address_line3": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_name": { "description": "A name set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_routing_number": { "description": "The creditor's routing number.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be \"USD\".", "type": "string", "x-documentation-priority": "default" }, "debtor_address_line1": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line2": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line3": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_name": { "description": "A name set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "end_to_end_identification": { "description": "A free-form reference string set by the sender, to help identify the drawdown request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The Wire drawdown request identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Drawdown Requests" }, "input_message_accountability_data": { "description": "A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "instruction_identification": { "description": "The sending bank's identifier for the drawdown request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "recipient_account_number_id": { "description": "The Account Number from which the recipient of this request is being requested to send funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_wire_drawdown_request`.", "enum": [ "inbound_wire_drawdown_request" ], "type": "string", "x-documentation-priority": "default" }, "unique_end_to_end_transaction_reference": { "description": "The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the drawdown request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unstructured_remittance_information": { "description": "A free-form message set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "type", "id", "created_at", "recipient_account_number_id", "amount", "currency", "input_message_accountability_data", "unique_end_to_end_transaction_reference", "instruction_identification", "end_to_end_identification", "creditor_name", "creditor_routing_number", "creditor_account_number", "creditor_address_line1", "creditor_address_line2", "creditor_address_line3", "debtor_name", "debtor_address_line1", "debtor_address_line2", "debtor_address_line3", "unstructured_remittance_information" ], "title": "Inbound Wire Drawdown Request", "type": "object", "x-event-categories": [ "inbound_wire_drawdown_request.created" ], "x-tag": "Inbound Wire Drawdown Requests", "x-title-plural": "Inbound Wire Drawdown Requests" }, "inbound_wire_drawdown_request_list": { "additionalProperties": true, "description": "A list of Inbound Wire Drawdown Request objects.", "example": { "data": [ { "amount": 10000, "created_at": "2020-01-31T23:59:59Z", "creditor_account_number": "987654321", "creditor_address_line1": "33 Liberty Street", "creditor_address_line2": "New York, NY, 10045", "creditor_address_line3": null, "creditor_name": "Ian Crease", "creditor_routing_number": "101050001", "currency": "USD", "debtor_address_line1": "33 Liberty Street", "debtor_address_line2": "New York, NY, 10045", "debtor_address_line3": null, "debtor_name": "Ian Crease", "end_to_end_identification": "Invoice 29582", "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e", "input_message_accountability_data": null, "instruction_identification": null, "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "type": "inbound_wire_drawdown_request", "unique_end_to_end_transaction_reference": null, "unstructured_remittance_information": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_wire_drawdown_request" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound Wire Drawdown Request List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Wire Drawdown Request Lists" }, "inbound_wire_transfer": { "additionalProperties": true, "description": "An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.", "example": { "acceptance": null, "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "creditor_address_line1": null, "creditor_address_line2": null, "creditor_address_line3": null, "creditor_name": null, "debtor_address_line1": null, "debtor_address_line2": null, "debtor_address_line3": null, "debtor_name": null, "description": "Inbound wire transfer", "end_to_end_identification": null, "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "input_message_accountability_data": null, "instructing_agent_routing_number": null, "instruction_identification": null, "reversal": null, "status": "accepted", "type": "inbound_wire_transfer", "unique_end_to_end_transaction_reference": null, "unstructured_remittance_information": null, "wire_drawdown_request_id": null }, "properties": { "acceptance": { "additionalProperties": false, "description": "If the transfer is accepted, this will contain details of the acceptance.", "properties": { "accepted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was accepted.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the transaction for the accepted transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "accepted_at", "transaction_id" ], "title": "Inbound Wire Transfer Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Acceptances", "nullable": true }, "account_id": { "description": "The Account to which the transfer belongs.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number_id": { "description": "The identifier of the Account Number to which this transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creditor_address_line1": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_address_line2": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_address_line3": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_name": { "description": "A name set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line1": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line2": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line3": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_name": { "description": "A name set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "description": { "description": "An Increase-constructed description of the transfer.", "type": "string", "x-documentation-priority": "default" }, "end_to_end_identification": { "description": "A free-form reference string set by the sender, to help identify the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The inbound wire transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers" }, "input_message_accountability_data": { "description": "A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "instructing_agent_routing_number": { "description": "The American Banking Association (ABA) routing number of the bank that sent the wire.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "instruction_identification": { "description": "The sending bank's identifier for the wire transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reversal": { "additionalProperties": false, "description": "If the transfer is reversed, this will contain details of the reversal.", "properties": { "reason": { "description": "The reason for the reversal.", "enum": [ "duplicate", "creditor_request", "transaction_forbidden" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The inbound wire transfer was a duplicate.", "The recipient of the wire transfer requested the funds be returned to the sender.", "The account cannot currently receive inbound wires." ] }, "reversed_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was reversed.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "reason", "reversed_at" ], "title": "Inbound Wire Transfer Reversal", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Reversals", "nullable": true }, "status": { "description": "The status of the transfer.", "enum": [ "pending", "accepted", "declined", "reversed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Inbound Wire Transfer is awaiting action, will transition automatically if no action is taken.", "The Inbound Wire Transfer is accepted.", "The Inbound Wire Transfer was declined.", "The Inbound Wire Transfer was reversed." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `inbound_wire_transfer`.", "enum": [ "inbound_wire_transfer" ], "type": "string", "x-documentation-priority": "default" }, "unique_end_to_end_transaction_reference": { "description": "The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unstructured_remittance_information": { "description": "A free-form message set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "wire_drawdown_request_id": { "description": "The wire drawdown request the inbound wire transfer is fulfilling.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests", "nullable": true } }, "required": [ "type", "id", "amount", "account_id", "account_number_id", "status", "created_at", "description", "input_message_accountability_data", "creditor_address_line1", "creditor_address_line2", "creditor_address_line3", "creditor_name", "end_to_end_identification", "debtor_address_line1", "debtor_address_line2", "debtor_address_line3", "debtor_name", "instructing_agent_routing_number", "unstructured_remittance_information", "instruction_identification", "unique_end_to_end_transaction_reference", "wire_drawdown_request_id", "acceptance", "reversal" ], "title": "Inbound Wire Transfer", "type": "object", "x-event-categories": [ "inbound_wire_transfer.created", "inbound_wire_transfer.updated" ], "x-tag": "Inbound Wire Transfers", "x-title-plural": "Inbound Wire Transfers" }, "inbound_wire_transfer_list": { "additionalProperties": true, "description": "A list of Inbound Wire Transfer objects.", "example": { "data": [ { "acceptance": null, "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "creditor_address_line1": null, "creditor_address_line2": null, "creditor_address_line3": null, "creditor_name": null, "debtor_address_line1": null, "debtor_address_line2": null, "debtor_address_line3": null, "debtor_name": null, "description": "Inbound wire transfer", "end_to_end_identification": null, "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "input_message_accountability_data": null, "instructing_agent_routing_number": null, "instruction_identification": null, "reversal": null, "status": "accepted", "type": "inbound_wire_transfer", "unique_end_to_end_transaction_reference": null, "unstructured_remittance_information": null, "wire_drawdown_request_id": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/inbound_wire_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Inbound Wire Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Wire Transfer Lists" }, "inbound_wire_transfer_reversal": { "additionalProperties": true, "description": "An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed.", "example": { "inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0" }, "properties": { "inbound_wire_transfer_id": { "description": "The ID of the Inbound Wire Transfer that is being reversed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers" } }, "required": [ "inbound_wire_transfer_id" ], "title": "Inbound Wire Transfer Reversal Intention", "type": "object", "x-event-categories": [], "x-title-plural": "Inbound Wire Transfer Reversal Intentions" }, "intrafi_account_enrollment": { "additionalProperties": false, "description": "IntraFi is a [network of financial institutions](https://www.intrafi.com/network-banks) that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "email_address": null, "id": "intrafi_account_enrollment_w8l97znzreopkwf2tg75", "idempotency_key": null, "intrafi_id": "01234abcd", "status": "pending_enrolling", "type": "intrafi_account_enrollment" }, "properties": { "account_id": { "description": "The identifier of the Increase Account being swept into the network.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the enrollment was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "email_address": { "description": "The contact email for the account owner, to be shared with IntraFi.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The identifier of this enrollment at IntraFi.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "IntraFi Account Enrollments" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "intrafi_id": { "description": "The identifier of the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.", "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The status of the account in the network. An account takes about one business day to go from `pending_enrolling` to `enrolled`.", "enum": [ "pending_enrolling", "enrolled", "pending_unenrolling", "unenrolled", "requires_attention" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account is being added to the IntraFi network.", "The account has been enrolled with IntraFi.", "The account is being unenrolled from IntraFi's deposit sweep.", "The account was once enrolled, but is no longer enrolled at IntraFi.", "Something unexpected happened with this account. Contact Increase support." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `intrafi_account_enrollment`.", "enum": [ "intrafi_account_enrollment" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "account_id", "status", "created_at", "intrafi_id", "email_address", "idempotency_key" ], "title": "IntraFi Account Enrollment", "type": "object", "x-event-categories": [ "intrafi_account_enrollment.created", "intrafi_account_enrollment.updated" ], "x-tag": "IntraFi Account Enrollments", "x-title-plural": "IntraFi Account Enrollments" }, "intrafi_account_enrollment_list": { "additionalProperties": true, "description": "A list of IntraFi Account Enrollment objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "email_address": null, "id": "intrafi_account_enrollment_w8l97znzreopkwf2tg75", "idempotency_key": null, "intrafi_id": "01234abcd", "status": "pending_enrolling", "type": "intrafi_account_enrollment" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/intrafi_account_enrollment" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "IntraFi Account Enrollment List", "type": "object", "x-event-categories": [], "x-title-plural": "IntraFi Account Enrollment Lists" }, "intrafi_balance": { "additionalProperties": true, "description": "When using IntraFi, each account's balance over the standard FDIC insurance amount is swept to various other institutions. Funds are rebalanced across banks as needed once per business day.", "example": { "balances": [ { "balance": 1750, "bank": "Example Bank", "bank_location": { "city": "New York", "state": "NY" }, "fdic_certificate_number": "314159" } ], "currency": "USD", "effective_date": "2020-01-31", "total_balance": 1750, "type": "intrafi_balance" }, "properties": { "balances": { "description": "Each entry represents a balance held at a different bank. IntraFi separates the total balance across many participating banks in the network.", "items": { "additionalProperties": true, "properties": { "balance": { "description": "The balance, in minor units of `currency`, held with this bank.", "type": "integer", "x-documentation-priority": "default" }, "bank": { "description": "The name of the bank holding these funds.", "type": "string", "x-documentation-priority": "default" }, "bank_location": { "additionalProperties": false, "description": "The primary location of the bank.", "properties": { "city": { "description": "The bank's city.", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The bank's state.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "city", "state" ], "title": "IntraFi Balance BalancesElement BankLocation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "BankLocations", "nullable": true }, "fdic_certificate_number": { "description": "The Federal Deposit Insurance Corporation (FDIC) certificate number of the bank. Because many banks have the same or similar names, this can be used to uniquely identify the institution.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "bank", "bank_location", "fdic_certificate_number", "balance" ], "title": "IntraFi Balance BalancesElement", "type": "object", "x-event-categories": [], "x-title-plural": "BalancesElements" }, "type": "array", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the account currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "effective_date": { "description": "The date this balance reflects.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "total_balance": { "description": "The total balance, in minor units of `currency`. Increase reports this balance to IntraFi daily.", "type": "integer", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `intrafi_balance`.", "enum": [ "intrafi_balance" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "effective_date", "total_balance", "currency", "balances" ], "title": "IntraFi Balance", "type": "object", "x-event-categories": [], "x-tag": "IntraFi Balances", "x-title-plural": "IntraFi Balances" }, "intrafi_exclusion": { "additionalProperties": false, "description": "Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.", "example": { "bank_name": "Example Bank", "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "excluded_at": "2020-02-01T23:59:59+00:00", "fdic_certificate_number": "314159", "id": "intrafi_exclusion_ygfqduuzpau3jqof6jyh", "idempotency_key": null, "status": "completed", "submitted_at": "2020-02-01T00:59:59+00:00", "type": "intrafi_exclusion" }, "properties": { "bank_name": { "description": "The name of the excluded institution.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the exclusion was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "entity_id": { "description": "The entity for which this institution is excluded.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "excluded_at": { "description": "When this was exclusion was confirmed by IntraFi.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "fdic_certificate_number": { "description": "The Federal Deposit Insurance Corporation's certificate number for the institution.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The identifier of this exclusion request.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "IntraFi Exclusions" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The status of the exclusion request.", "enum": [ "pending", "completed", "archived", "ineligible" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The exclusion is being added to the IntraFi network.", "The exclusion has been added to the IntraFi network.", "The exclusion has been removed from the IntraFi network.", "The exclusion wasn't eligible to be added to the IntraFi network." ] }, "submitted_at": { "description": "When this was exclusion was submitted to IntraFi by Increase.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `intrafi_exclusion`.", "enum": [ "intrafi_exclusion" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "submitted_at", "excluded_at", "bank_name", "fdic_certificate_number", "entity_id", "status", "idempotency_key" ], "title": "IntraFi Exclusion", "type": "object", "x-event-categories": [ "intrafi_exclusion.created", "intrafi_exclusion.updated" ], "x-tag": "IntraFi Exclusions", "x-title-plural": "IntraFi Exclusions" }, "intrafi_exclusion_list": { "additionalProperties": true, "description": "A list of IntraFi Exclusion objects.", "example": { "data": [ { "bank_name": "Example Bank", "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "excluded_at": "2020-02-01T23:59:59+00:00", "fdic_certificate_number": "314159", "id": "intrafi_exclusion_ygfqduuzpau3jqof6jyh", "idempotency_key": null, "status": "completed", "submitted_at": "2020-02-01T00:59:59+00:00", "type": "intrafi_exclusion" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/intrafi_exclusion" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "IntraFi Exclusion List", "type": "object", "x-event-categories": [], "x-title-plural": "IntraFi Exclusion Lists" }, "lockbox_address": { "additionalProperties": false, "description": "Lockbox Addresses are physical locations that can receive mail containing paper checks.", "example": { "address": { "city": "San Francisco", "line1": "1234 Market St", "line2": "Ste 567", "postal_code": "94114", "state": "CA" }, "created_at": "2020-01-31T23:59:59Z", "description": "Lockbox Address 1", "id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "idempotency_key": null, "status": "active", "type": "lockbox_address" }, "properties": { "address": { "additionalProperties": false, "description": "The mailing address for the Lockbox Address. It will be present after Increase generates it.", "properties": { "city": { "description": "The city of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code of the address.", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "line2", "city", "state", "postal_code" ], "title": "Lockbox Address Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Address was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "The description you choose for the Lockbox Address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The Lockbox Address identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The status of the Lockbox Address.", "enum": [ "pending", "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase is generating this Lockbox Address.", "This Lockbox Address is active.", "This Lockbox Address is disabled.", "This Lockbox Address is permanently disabled." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `lockbox_address`.", "enum": [ "lockbox_address" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "description", "status", "address", "idempotency_key" ], "title": "Lockbox Address", "type": "object", "x-event-categories": [], "x-tag": "Lockbox Addresses", "x-title-plural": "Lockbox Addresses" }, "lockbox_address_list": { "additionalProperties": true, "description": "A list of Lockbox Address objects.", "example": { "data": [ { "address": { "city": "San Francisco", "line1": "1234 Market St", "line2": "Ste 567", "postal_code": "94114", "state": "CA" }, "created_at": "2020-01-31T23:59:59Z", "description": "Lockbox Address 1", "id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "idempotency_key": null, "status": "active", "type": "lockbox_address" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/lockbox_address" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Lockbox Address List", "type": "object", "x-event-categories": [], "x-title-plural": "Lockbox Address Lists" }, "lockbox_recipient": { "additionalProperties": false, "description": "Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "description": null, "id": "lockbox_3xt21ok13q19advds4t5", "idempotency_key": null, "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "mail_stop_code": "VRE6P", "recipient_name": "Company Inc.", "status": "active", "type": "lockbox_recipient" }, "properties": { "account_id": { "description": "The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Recipient was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "description": { "description": "The description of the Lockbox Recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The Lockbox Recipient identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "lockbox_address_id": { "description": "The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" }, "mail_stop_code": { "description": "The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Address. It should be included in the mailing address intended for this Lockbox Recipient.", "type": "string", "x-documentation-priority": "default" }, "recipient_name": { "description": "The name of the Lockbox Recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The status of the Lockbox Recipient.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This Lockbox Recipient is active.", "This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.", "This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected." ], "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `lockbox_recipient`.", "enum": [ "lockbox_recipient" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "id", "created_at", "recipient_name", "description", "mail_stop_code", "lockbox_address_id", "status", "idempotency_key" ], "title": "Lockbox Recipient", "type": "object", "x-event-categories": [ "lockbox.created", "lockbox.updated" ], "x-tag": "Lockbox Recipients", "x-title-plural": "Lockbox Recipients" }, "lockbox_recipient_list": { "additionalProperties": true, "description": "A list of Lockbox Recipient objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "description": null, "id": "lockbox_3xt21ok13q19advds4t5", "idempotency_key": null, "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "mail_stop_code": "VRE6P", "recipient_name": "Company Inc.", "status": "active", "type": "lockbox_recipient" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/lockbox_recipient" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Lockbox Recipient List", "type": "object", "x-event-categories": [], "x-title-plural": "Lockbox Recipient Lists" }, "oauth_application": { "additionalProperties": false, "description": "An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth [here](https://increase.com/documentation/oauth).", "example": { "client_id": "client_id_ec79nb1bukwwafdewe88", "created_at": "2020-01-31T23:59:59Z", "deleted_at": null, "id": "application_gj9ufmpgh5i56k4vyriy", "name": "Ian Crease's App", "status": "active", "type": "oauth_application" }, "properties": { "client_id": { "description": "The OAuth Application's client_id. Use this to authenticate with the OAuth Application.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Application was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "deleted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Application was deleted.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "id": { "description": "The OAuth Application's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "OAuth Applications" }, "name": { "description": "The name you chose for this OAuth Application.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "Whether the application is active.", "enum": [ "active", "deleted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The application is active and can be used by your users.", "The application is deleted." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `oauth_application`.", "enum": [ "oauth_application" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "client_id", "created_at", "name", "status", "deleted_at" ], "title": "OAuth Application", "type": "object", "x-event-categories": [], "x-tag": "OAuth Applications", "x-title-plural": "OAuth Applications" }, "oauth_application_list": { "additionalProperties": true, "description": "A list of OAuth Application objects.", "example": { "data": [ { "client_id": "client_id_ec79nb1bukwwafdewe88", "created_at": "2020-01-31T23:59:59Z", "deleted_at": null, "id": "application_gj9ufmpgh5i56k4vyriy", "name": "Ian Crease's App", "status": "active", "type": "oauth_application" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/oauth_application" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "OAuth Application List", "type": "object", "x-event-categories": [], "x-title-plural": "OAuth Application Lists" }, "oauth_connection": { "additionalProperties": false, "description": "When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth [here](https://increase.com/documentation/oauth).", "example": { "created_at": "2020-01-31T23:59:59Z", "deleted_at": null, "group_id": "group_1g4mhziu6kvrs3vz35um", "id": "connection_dauknoksyr4wilz4e6my", "oauth_application_id": "application_gj9ufmpgh5i56k4vyriy", "status": "active", "type": "oauth_connection" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Connection was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "deleted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Connection was deleted.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "group_id": { "description": "The identifier of the Group that has authorized your OAuth application.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Groups" }, "id": { "description": "The OAuth Connection's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "OAuth Connections" }, "oauth_application_id": { "description": "The identifier of the OAuth application this connection is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "OAuth Applications" }, "status": { "description": "Whether the connection is active.", "enum": [ "active", "inactive" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The OAuth connection is active.", "The OAuth connection is permanently deactivated." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `oauth_connection`.", "enum": [ "oauth_connection" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "group_id", "oauth_application_id", "status", "deleted_at" ], "title": "OAuth Connection", "type": "object", "x-event-categories": [], "x-tag": "OAuth Connections", "x-title-plural": "OAuth Connections" }, "oauth_connection_list": { "additionalProperties": true, "description": "A list of OAuth Connection objects.", "example": { "data": [ { "created_at": "2020-01-31T23:59:59Z", "deleted_at": null, "group_id": "group_1g4mhziu6kvrs3vz35um", "id": "connection_dauknoksyr4wilz4e6my", "oauth_application_id": "application_gj9ufmpgh5i56k4vyriy", "status": "active", "type": "oauth_connection" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/oauth_connection" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "OAuth Connection List", "type": "object", "x-event-categories": [], "x-title-plural": "OAuth Connection Lists" }, "oauth_token": { "additionalProperties": false, "description": "A token that is returned to your application when a user completes the OAuth flow and may be used to authenticate requests. Learn more about OAuth [here](/documentation/oauth).", "example": { "access_token": "12345", "group_id": "group_1g4mhziu6kvrs3vz35um", "token_type": "bearer", "type": "oauth_token" }, "properties": { "access_token": { "description": "You may use this token in place of an API key to make OAuth requests on a user's behalf.", "type": "string", "x-documentation-priority": "default" }, "group_id": { "description": "The Group's identifier. A Group is the top-level organization in Increase.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Groups" }, "token_type": { "description": "The type of OAuth token.", "enum": [ "bearer" ], "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `oauth_token`.", "enum": [ "oauth_token" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "access_token", "group_id", "token_type" ], "title": "OAuth Token", "type": "object", "x-event-categories": [], "x-tag": "OAuth Tokens", "x-title-plural": "OAuth Tokens" }, "pending_transaction": { "additionalProperties": true, "description": "Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).", "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "completed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "held_amount": 100, "id": "pending_transaction_k1sfetcau2qbvjbzgju4", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "ach_transfer_instruction": { "amount": 100, "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "category": "ach_transfer_instruction" }, "status": "pending", "type": "pending_transaction" }, "properties": { "account_id": { "description": "The identifier for the account this Pending Transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "completed_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction was completed.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction occurred.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "description": { "description": "For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.", "type": "string", "x-documentation-priority": "default" }, "held_amount": { "description": "The amount that this Pending Transaction decrements the available balance of its Account. This is usually the same as `amount`, but will differ if the amount is positive.", "type": "integer", "x-documentation-priority": "default" }, "id": { "description": "The Pending Transaction identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions" }, "route_id": { "description": "The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "route_type": { "description": "The type of the route this Pending Transaction came through.", "enum": [ "account_number", "card", "lockbox" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An Account Number.", "A Card.", "A Lockbox." ], "nullable": true }, "source": { "additionalProperties": true, "description": "This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.", "example": { "ach_transfer_instruction": { "amount": 100, "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "category": "ach_transfer_instruction" }, "properties": { "account_transfer_instruction": { "additionalProperties": true, "description": "An Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.", "example": { "amount": 100, "currency": "USD", "transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n" }, "properties": { "amount": { "description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "transfer_id": { "description": "The identifier of the Account Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Transfers" } }, "required": [ "amount", "currency", "transfer_id" ], "title": "Pending Transaction Pending Transaction Source Account Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Account Transfer Instructions", "nullable": true }, "ach_transfer_instruction": { "additionalProperties": true, "description": "An ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.", "example": { "amount": 100, "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "properties": { "amount": { "description": "The pending amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the ACH Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } }, "required": [ "amount", "transfer_id" ], "title": "Pending Transaction Pending Transaction Source ACH Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Instructions", "nullable": true }, "blockchain_offramp_transfer_instruction": { "additionalProperties": true, "description": "A Blockchain Off-Ramp Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_offramp_transfer_instruction`.", "example": { "source_blockchain_address_id": "blockchain_address_tijjpqp9t5d358ehydqi", "transfer_id": "blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m" }, "properties": { "source_blockchain_address_id": { "description": "The identifier of the Blockchain Address the funds were received at.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Blockchain Addresses" }, "transfer_id": { "description": "The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Blockchain Off-Ramp Transfers" } }, "required": [ "transfer_id", "source_blockchain_address_id" ], "title": "Pending Transaction Pending Transaction Source Blockchain Off-Ramp Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Blockchain Off-Ramp Transfer Instructions", "nullable": true }, "blockchain_onramp_transfer_instruction": { "additionalProperties": false, "description": "A Blockchain On-Ramp Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_onramp_transfer_instruction`.", "example": { "amount": 10000, "destination_blockchain_address": "0x304a554a310C7e546dfe434669C62820b7D83490", "transfer_id": "blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv" }, "properties": { "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "destination_blockchain_address": { "description": "The blockchain address the funds are being sent to.", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Blockchain On-Ramp Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Blockchain On-Ramp Transfers" } }, "required": [ "amount", "transfer_id", "destination_blockchain_address" ], "title": "Pending Transaction Pending Transaction Source Blockchain On-Ramp Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Blockchain On-Ramp Transfer Instructions", "nullable": true }, "card_authorization": { "description": "A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`. Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_authorization" } ], "nullable": true }, "card_push_transfer_instruction": { "additionalProperties": false, "description": "A Card Push Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `card_push_transfer_instruction`.", "example": { "amount": 100, "transfer_id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye" }, "properties": { "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Card Push Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Push Transfers" } }, "required": [ "amount", "transfer_id" ], "title": "Pending Transaction Pending Transaction Source Card Push Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Push Transfer Instructions", "nullable": true }, "category": { "description": "The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "account_transfer_instruction", "ach_transfer_instruction", "card_authorization", "check_deposit_instruction", "check_transfer_instruction", "fednow_transfer_instruction", "inbound_funds_hold", "user_initiated_hold", "real_time_payments_transfer_instruction", "wire_transfer_instruction", "inbound_wire_transfer_reversal", "swift_transfer_instruction", "card_push_transfer_instruction", "blockchain_onramp_transfer_instruction", "blockchain_offramp_transfer_instruction", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account Transfer Instruction: details will be under the `account_transfer_instruction` object.", "ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.", "Card Authorization: details will be under the `card_authorization` object.", "Check Deposit Instruction: details will be under the `check_deposit_instruction` object.", "Check Transfer Instruction: details will be under the `check_transfer_instruction` object.", "FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.", "Inbound Funds Hold: details will be under the `inbound_funds_hold` object.", "User Initiated Hold: details will be under the `user_initiated_hold` object.", "Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.", "Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.", "Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.", "Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.", "Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.", "Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.", "Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.", "The Pending Transaction was made for an undocumented or deprecated reason." ] }, "check_deposit_instruction": { "additionalProperties": true, "description": "A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.", "example": { "amount": 100, "back_image_file_id": "file_26khfk98mzfz90a11oqx", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "front_image_file_id": "file_makxrc67oh9l6sg7w9yc" }, "properties": { "amount": { "description": "The pending amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "back_image_file_id": { "description": "The identifier of the File containing the image of the back of the check that was deposited.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "check_deposit_id": { "description": "The identifier of the Check Deposit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "front_image_file_id": { "description": "The identifier of the File containing the image of the front of the check that was deposited.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "amount", "currency", "front_image_file_id", "back_image_file_id", "check_deposit_id" ], "title": "Pending Transaction Pending Transaction Source Check Deposit Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Instructions", "nullable": true }, "check_transfer_instruction": { "additionalProperties": true, "description": "A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.", "example": { "amount": 100, "currency": "USD", "transfer_id": "check_transfer_30b43acfu9vw8fyc4f5" }, "properties": { "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "transfer_id": { "description": "The identifier of the Check Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } }, "required": [ "amount", "currency", "transfer_id" ], "title": "Pending Transaction Pending Transaction Source Check Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Transfer Instructions", "nullable": true }, "fednow_transfer_instruction": { "additionalProperties": true, "description": "A FedNow Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `fednow_transfer_instruction`.", "example": { "transfer_id": "fednow_transfer_4i0mptrdu1mueg1196bg" }, "properties": { "transfer_id": { "description": "The identifier of the FedNow Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "FedNow Transfers" } }, "required": [ "transfer_id" ], "title": "Pending Transaction Pending Transaction Source FedNow Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "FedNow Transfer Instructions", "nullable": true }, "inbound_funds_hold": { "description": "An Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`. We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_funds_hold" } ], "nullable": true }, "inbound_wire_transfer_reversal": { "description": "An Inbound Wire Transfer Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal is created when Increase has received a wire and the User requests that it be reversed.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_wire_transfer_reversal" } ], "nullable": true }, "other": { "additionalProperties": false, "description": "If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null.", "properties": {}, "title": "Pending Transaction Pending Transaction Source Other", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Others", "nullable": true }, "real_time_payments_transfer_instruction": { "additionalProperties": false, "description": "A Real-Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_instruction`.", "example": { "amount": 100, "transfer_id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq" }, "properties": { "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Real-Time Payments Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" } }, "required": [ "amount", "transfer_id" ], "title": "Pending Transaction Pending Transaction Source Real-Time Payments Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Real-Time Payments Transfer Instructions", "nullable": true }, "swift_transfer_instruction": { "additionalProperties": true, "description": "A Swift Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_instruction`.", "example": { "transfer_id": "swift_transfer_29h21xkng03788zwd3fh" }, "properties": { "transfer_id": { "description": "The identifier of the Swift Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" } }, "required": [ "transfer_id" ], "title": "Pending Transaction Pending Transaction Source Swift Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Swift Transfer Instructions", "nullable": true }, "user_initiated_hold": { "additionalProperties": true, "description": "An User Initiated Hold object. This field will be present in the JSON response if and only if `category` is equal to `user_initiated_hold`. Created when a user initiates a hold on funds in their account.", "properties": {}, "title": "Pending Transaction Pending Transaction Source User Initiated Hold", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "User Initiated Holds", "nullable": true }, "wire_transfer_instruction": { "additionalProperties": true, "description": "A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`.", "example": { "account_number": "987654321", "amount": 100, "message_to_recipient": "HELLO", "routing_number": "101050001", "transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u" }, "properties": { "account_number": { "description": "The account number for the destination account.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "message_to_recipient": { "description": "The message that will show on the recipient's bank statement.", "type": "string", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Wire Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } }, "required": [ "amount", "account_number", "routing_number", "message_to_recipient", "transfer_id" ], "title": "Pending Transaction Pending Transaction Source Wire Transfer Instruction", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Wire Transfer Instructions", "nullable": true } }, "required": [ "category" ], "title": "Pending Transaction Pending Transaction Source", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pending Transaction Sources" }, "status": { "description": "Whether the Pending Transaction has been confirmed and has an associated Transaction.", "enum": [ "pending", "complete" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Pending Transaction is still awaiting confirmation.", "The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `pending_transaction`.", "enum": [ "pending_transaction" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "amount", "held_amount", "currency", "completed_at", "created_at", "description", "id", "route_id", "route_type", "source", "status" ], "title": "Pending Transaction", "type": "object", "x-event-categories": [ "pending_transaction.created", "pending_transaction.updated" ], "x-tag": "Pending Transactions", "x-title-plural": "Pending Transactions" }, "pending_transaction_list": { "additionalProperties": true, "description": "A list of Pending Transaction objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "completed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "held_amount": 100, "id": "pending_transaction_k1sfetcau2qbvjbzgju4", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "ach_transfer_instruction": { "amount": 100, "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "category": "ach_transfer_instruction" }, "status": "pending", "type": "pending_transaction" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/pending_transaction" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Pending Transaction List", "type": "object", "x-event-categories": [], "x-title-plural": "Pending Transaction Lists" }, "physical_card": { "additionalProperties": false, "description": "Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile](/documentation/api#card-profiles). The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact [support@increase.com](mailto:support@increase.com) for pricing!", "example": { "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "first_name": "Ian", "last_name": "Crease" }, "created_at": "2020-01-31T23:59:59Z", "id": "physical_card_ode8duyq5v2ynhjoharl", "idempotency_key": null, "physical_card_profile_id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "shipment": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": "Unit 2", "line3": null, "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "method": "usps", "schedule": "next_day", "status": "shipped", "tracking": { "number": "9400110200881234567890", "return_number": null, "return_reason": null, "shipped_at": "2020-01-31T23:59:59Z", "updates": [ { "carrier_estimated_delivery_at": null, "category": "delivered", "city": null, "created_at": "2020-01-31T23:59:59Z", "postal_code": "10001", "state": null } ] } }, "status": "active", "type": "physical_card" }, "properties": { "card_id": { "description": "The identifier for the Card this Physical Card represents.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "cardholder": { "additionalProperties": false, "description": "Details about the cardholder, as it appears on the printed card.", "properties": { "first_name": { "description": "The cardholder's first name.", "type": "string", "x-documentation-priority": "default" }, "last_name": { "description": "The cardholder's last name.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "first_name", "last_name" ], "title": "Physical Card Cardholder", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cardholders" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Card was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The physical card identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "physical_card_profile_id": { "description": "The Physical Card Profile used for this Physical Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Card Profiles", "nullable": true }, "shipment": { "additionalProperties": false, "description": "The details used to ship this physical card.", "properties": { "address": { "additionalProperties": false, "description": "The location to where the card's packing label is addressed.", "properties": { "city": { "description": "The city of the shipping address.", "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The country of the shipping address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the shipping address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the shipping address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line3": { "description": "The third line of the shipping address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "name": { "description": "The name of the recipient.", "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code of the shipping address.", "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The state of the shipping address.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name", "line1", "line2", "line3", "city", "state", "postal_code", "country" ], "title": "Physical Card Shipment Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "method": { "description": "The shipping method.", "enum": [ "usps", "fedex_priority_overnight", "fedex_2_day", "dhl_worldwide_express" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "USPS Post.", "FedEx Priority Overnight, no signature.", "FedEx 2-day.", "DHL Worldwide Express, international shipping only." ] }, "schedule": { "description": "When this physical card should be produced by the card printer. The default timeline is the day after the card printer receives the order, except for `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster production methods, please reach out to [support@increase.com](mailto:support@increase.com).", "enum": [ "next_day", "same_day" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card will be shipped one business day after the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Wednesday.", "The physical card will be shipped on the same business day that the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Tuesday." ] }, "status": { "description": "The status of this shipment.", "enum": [ "pending", "canceled", "submitted", "acknowledged", "rejected", "shipped", "returned", "requires_attention" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card has not yet been shipped.", "The physical card shipment was canceled prior to submission.", "The physical card shipment has been submitted to the card fulfillment provider.", "The physical card shipment has been acknowledged by the card fulfillment provider and will be processed in their next batch.", "The physical card shipment was rejected by the card printer due to an error.", "The physical card has been shipped.", "The physical card shipment was returned to the sender and destroyed by the production facility.", "The physical card shipment requires attention from Increase before progressing." ] }, "tracking": { "additionalProperties": false, "description": "Tracking details for the shipment.", "properties": { "number": { "description": "The tracking number. Not available for USPS shipments.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_number": { "description": "For returned shipments, the tracking number of the return shipment.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason": { "description": "For returned shipments, this describes why the package was returned.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipped_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the fulfillment provider marked the card as ready for pick-up by the shipment carrier.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "updates": { "description": "Tracking updates relating to the physical card's delivery.", "items": { "additionalProperties": false, "properties": { "carrier_estimated_delivery_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "category": { "description": "The type of tracking event.", "enum": [ "in_transit", "processed_for_delivery", "delivered", "delivery_issue", "returned_to_sender" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card is in transit.", "The physical card has been processed for delivery.", "The physical card has been delivered.", "There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.", "Delivery failed and the physical card was returned to sender." ] }, "city": { "description": "The city where the event took place.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the tracking event took place.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code where the event took place.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The state where the event took place.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "category", "created_at", "carrier_estimated_delivery_at", "postal_code", "city", "state" ], "title": "Physical Card Shipment Tracking UpdatesElement", "type": "object", "x-event-categories": [], "x-title-plural": "UpdatesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "number", "shipped_at", "return_reason", "return_number", "updates" ], "title": "Physical Card Shipment Tracking", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Trackings", "nullable": true } }, "required": [ "method", "schedule", "status", "tracking", "address" ], "title": "Physical Card Shipment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Shipments" }, "status": { "description": "The status of the Physical Card.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card is active.", "The physical card is temporarily disabled.", "The physical card is permanently canceled." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `physical_card`.", "enum": [ "physical_card" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "card_id", "physical_card_profile_id", "created_at", "status", "cardholder", "shipment", "idempotency_key" ], "title": "Physical Card", "type": "object", "x-event-categories": [ "physical_card.created", "physical_card.updated" ], "x-tag": "Physical Cards", "x-title-plural": "Physical Cards" }, "physical_card_list": { "additionalProperties": true, "description": "A list of Physical Card objects.", "example": { "data": [ { "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "first_name": "Ian", "last_name": "Crease" }, "created_at": "2020-01-31T23:59:59Z", "id": "physical_card_ode8duyq5v2ynhjoharl", "idempotency_key": null, "physical_card_profile_id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "shipment": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": "Unit 2", "line3": null, "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "method": "usps", "schedule": "next_day", "status": "shipped", "tracking": { "number": "9400110200881234567890", "return_number": null, "return_reason": null, "shipped_at": "2020-01-31T23:59:59Z", "updates": [ { "carrier_estimated_delivery_at": null, "category": "delivered", "city": null, "created_at": "2020-01-31T23:59:59Z", "postal_code": "10001", "state": null } ] } }, "status": "active", "type": "physical_card" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/physical_card" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Physical Card List", "type": "object", "x-event-categories": [], "x-title-plural": "Physical Card Lists" }, "physical_card_profile": { "additionalProperties": true, "description": "This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on [physical card artwork](https://increase.com/documentation/card-art-physical-cards).", "example": { "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "carrier_image_file_id": "file_makxrc67oh9l6sg7w9yc", "contact_phone": "+16505046304", "created_at": "2020-01-31T23:59:59Z", "creator": "user", "description": "Corporate logo card", "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "front_text": null, "id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "idempotency_key": null, "is_default": false, "program_id": "program_i2v2os4mwza1oetokh9i", "status": "active", "type": "physical_card_profile" }, "properties": { "back_image_file_id": { "description": "The identifier of the File containing the physical card's back image. This will be missing until the image has been post-processed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "carrier_image_file_id": { "description": "The identifier of the File containing the physical card's carrier image. This will be missing until the image has been post-processed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "contact_phone": { "description": "A phone number the user can contact to receive support for their card.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Card Profile was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creator": { "description": "The creator of this Physical Card Profile.", "enum": [ "increase", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This Physical Card Profile was created by Increase.", "This Physical Card Profile was created by you." ] }, "description": { "description": "A description you can use to identify the Physical Card Profile.", "type": "string", "x-documentation-priority": "default" }, "front_image_file_id": { "description": "The identifier of the File containing the physical card's front image. This will be missing until the image has been post-processed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files", "nullable": true }, "id": { "description": "The Card Profile identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Card Profiles" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "is_default": { "description": "Whether this Physical Card Profile is the default for all cards in its Increase group.", "type": "boolean", "x-documentation-priority": "default" }, "program_id": { "description": "The identifier for the Program this Physical Card Profile belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" }, "status": { "description": "The status of the Physical Card Profile.", "enum": [ "pending_creating", "pending_reviewing", "rejected", "pending_submitting", "active", "archived" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Card Profile has not yet been processed by Increase.", "The card profile is awaiting review by Increase.", "There is an issue with the Physical Card Profile preventing it from use.", "The card profile is awaiting submission to the fulfillment provider.", "The Physical Card Profile has been submitted to the fulfillment provider and is ready to use.", "The Physical Card Profile has been archived." ] }, "type": { "description": "A constant representing the object's type. For this resource it will always be `physical_card_profile`.", "enum": [ "physical_card_profile" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "status", "description", "program_id", "is_default", "creator", "contact_phone", "front_image_file_id", "back_image_file_id", "carrier_image_file_id", "idempotency_key" ], "title": "Physical Card Profile", "type": "object", "x-event-categories": [ "physical_card_profile.created", "physical_card_profile.updated" ], "x-tag": "Physical Card Profiles", "x-title-plural": "Physical Card Profiles" }, "physical_card_profile_list": { "additionalProperties": true, "description": "A list of Physical Card Profile objects.", "example": { "data": [ { "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "carrier_image_file_id": "file_makxrc67oh9l6sg7w9yc", "contact_phone": "+16505046304", "created_at": "2020-01-31T23:59:59Z", "creator": "user", "description": "Corporate logo card", "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "front_text": null, "id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "idempotency_key": null, "is_default": false, "program_id": "program_i2v2os4mwza1oetokh9i", "status": "active", "type": "physical_card_profile" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/physical_card_profile" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Physical Card Profile List", "type": "object", "x-event-categories": [], "x-title-plural": "Physical Card Profile Lists" }, "program": { "additionalProperties": false, "description": "Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.", "example": { "bank": "first_internet_bank", "billing_account_id": null, "created_at": "2020-01-31T23:59:59Z", "default_digital_card_profile_id": null, "id": "program_i2v2os4mwza1oetokh9i", "interest_rate": "0.01", "lending": null, "name": "Commercial Banking", "type": "program", "updated_at": "2020-01-31T23:59:59Z" }, "properties": { "bank": { "description": "The Bank the Program is with.", "enum": [ "core_bank", "first_internet_bank", "grasshopper_bank" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Core Bank", "First Internet Bank of Indiana", "Grasshopper Bank" ] }, "billing_account_id": { "description": "The Program billing account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "default_digital_card_profile_id": { "description": "The default configuration for digital cards attached to this Program.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles", "nullable": true }, "id": { "description": "The Program identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" }, "interest_rate": { "description": "The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as \"0.01\".", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "lending": { "additionalProperties": false, "description": "The lending details for the program.", "properties": { "maximum_extendable_credit": { "description": "The maximum extendable credit of the program.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "maximum_extendable_credit" ], "title": "Program Lending", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Lendings", "nullable": true }, "name": { "description": "The name of the Program.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `program`.", "enum": [ "program" ], "type": "string", "x-documentation-priority": "default" }, "updated_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was last updated.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "name", "created_at", "updated_at", "id", "billing_account_id", "default_digital_card_profile_id", "interest_rate", "bank", "lending" ], "title": "Program", "type": "object", "x-event-categories": [ "program.created", "program.updated" ], "x-tag": "Programs", "x-title-plural": "Programs" }, "program_list": { "additionalProperties": true, "description": "A list of Program objects.", "example": { "data": [ { "bank": "first_internet_bank", "billing_account_id": null, "created_at": "2020-01-31T23:59:59Z", "default_digital_card_profile_id": null, "id": "program_i2v2os4mwza1oetokh9i", "interest_rate": "0.01", "lending": null, "name": "Commercial Banking", "type": "program", "updated_at": "2020-01-31T23:59:59Z" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/program" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Program List", "type": "object", "x-event-categories": [], "x-title-plural": "Program Lists" }, "real_time_decision": { "additionalProperties": false, "description": "Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions).", "example": { "card_authentication": null, "card_authentication_challenge": null, "card_authorization": { "account_id": "account_in71c4amph0vgo2qllky", "additional_amounts": { "clinic": null, "dental": null, "original": null, "prescription": null, "surcharge": null, "total_cumulative": null, "total_healthcare": null, "transit": null, "unknown": null, "vision": null }, "approval": null, "card_id": "card_oubs0hwk5rn6knuecxg2", "decision": "approve", "decline": null, "digital_wallet_token_id": null, "direction": "settlement", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "pulse": null, "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null, "terminal_entry_capability": "magnetic_stripe" } }, "network_identifiers": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "partial_approval_capability": "not_supported", "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "request_details": { "category": "initial_authorization", "incremental_authorization": null, "initial_authorization": {} }, "settlement_amount": 100, "settlement_currency": "USD", "terminal_id": "RCN5VNXS", "upcoming_card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" }, "cardholder_name": null } }, "card_balance_inquiry": null, "category": "card_authorization_requested", "created_at": "2020-01-31T23:59:59Z", "digital_wallet_authentication": null, "digital_wallet_token": null, "id": "real_time_decision_j76n2e810ezcg3zh5qtn", "status": "pending", "timeout_at": "2020-01-31T23:59:59Z", "type": "real_time_decision" }, "properties": { "card_authentication": { "additionalProperties": false, "description": "Fields related to a 3DS authentication attempt.", "properties": { "access_control_server_transaction_identifier": { "description": "A unique identifier assigned by the Access Control Server (us) for this transaction.", "type": "string", "x-documentation-priority": "default" }, "account_id": { "description": "The identifier of the Account the card belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "billing_address_city": { "description": "The city of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_country": { "description": "The country of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_line1": { "description": "The first line of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_line2": { "description": "The second line of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_line3": { "description": "The third line of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_postal_code": { "description": "The postal code of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "billing_address_state": { "description": "The US state of the cardholder billing address associated with the card used for this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "card_id": { "description": "The identifier of the Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "cardholder_email": { "description": "The email address of the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "cardholder_name": { "description": "The name of the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "decision": { "description": "Whether or not the authentication attempt was approved.", "enum": [ "approve", "challenge", "deny" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the authentication attempt without triggering a challenge.", "Request further validation before approving the authentication attempt.", "Deny the authentication attempt." ], "nullable": true }, "device_channel": { "additionalProperties": false, "description": "The device channel of the card authentication attempt.", "properties": { "browser": { "additionalProperties": false, "description": "Fields specific to the browser device channel.", "properties": { "accept_header": { "description": "The accept header from the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "ip_address": { "description": "The IP address of the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "javascript_enabled": { "description": "Whether JavaScript is enabled in the cardholder's browser.", "enum": [ "enabled", "disabled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "JavaScript is enabled in the cardholder's browser.", "JavaScript is not enabled in the cardholder's browser." ], "nullable": true }, "language": { "description": "The language of the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "user_agent": { "description": "The user agent of the cardholder's browser.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "accept_header", "ip_address", "javascript_enabled", "language", "user_agent" ], "title": "Real-Time Decision CardAuthentication DeviceChannel Browser", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Browsers", "nullable": true }, "category": { "description": "The category of the device channel.", "enum": [ "app", "browser", "three_ds_requestor_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt was made from an app.", "The authentication attempt was made from a browser.", "The authentication attempt was initiated by the 3DS Requestor." ] }, "merchant_initiated": { "additionalProperties": false, "description": "Fields specific to merchant initiated transactions.", "properties": { "indicator": { "description": "The merchant initiated indicator for the transaction.", "enum": [ "recurring_transaction", "installment_transaction", "add_card", "maintain_card_information", "account_verification", "split_delayed_shipment", "top_up", "mail_order", "telephone_order", "whitelist_status_check", "other_payment", "billing_agreement", "device_binding_status_check", "card_security_code_status_check", "delayed_shipment", "split_payment", "fido_credential_deletion", "fido_credential_registration", "decoupled_authentication_fallback" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Recurring transaction.", "Installment transaction.", "Add card.", "Maintain card information.", "Account verification.", "Split or delayed shipment.", "Top up.", "Mail order.", "Telephone order.", "Whitelist status check.", "Other payment.", "Billing agreement.", "Device binding status check.", "Card security code status check.", "Delayed shipment.", "Split payment.", "FIDO credential deletion.", "FIDO credential registration.", "Decoupled authentication fallback." ] } }, "required": [ "indicator" ], "title": "Real-Time Decision CardAuthentication DeviceChannel MerchantInitiated", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "MerchantInitiateds", "nullable": true } }, "required": [ "category", "merchant_initiated", "browser" ], "title": "Real-Time Decision CardAuthentication DeviceChannel", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "directory_server_transaction_identifier": { "description": "A unique identifier assigned by the Directory Server (the card network) for this transaction.", "type": "string", "x-documentation-priority": "default" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_name": { "description": "The name of the merchant.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "message_category": { "additionalProperties": false, "description": "The message category of the card authentication attempt.", "properties": { "category": { "description": "The category of the card authentication attempt.", "enum": [ "payment_authentication", "non_payment_authentication" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt is for a payment.", "The authentication attempt is not for a payment." ] }, "non_payment": { "additionalProperties": false, "description": "Fields specific to non-payment authentication attempts.", "properties": {}, "title": "Real-Time Decision CardAuthentication MessageCategory NonPayment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "NonPayments", "nullable": true }, "payment": { "additionalProperties": false, "description": "Fields specific to payment authentication attempts.", "properties": { "purchase_amount": { "description": "The purchase amount in minor units.", "type": "integer", "x-documentation-priority": "default" }, "purchase_amount_cardholder_estimated": { "description": "The purchase amount in the cardholder's currency (i.e., USD) estimated using daily conversion rates from the card network.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "purchase_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt's purchase currency.", "type": "string", "x-documentation-priority": "default" }, "transaction_type": { "description": "The type of transaction being authenticated.", "enum": [ "goods_service_purchase", "check_acceptance", "account_funding", "quasi_cash_transaction", "prepaid_activation_and_load" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Purchase of goods or services.", "Check acceptance.", "Account funding.", "Quasi-cash transaction.", "Prepaid activation and load." ], "nullable": true } }, "required": [ "purchase_amount", "purchase_currency", "purchase_amount_cardholder_estimated", "transaction_type" ], "title": "Real-Time Decision CardAuthentication MessageCategory Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Payments", "nullable": true } }, "required": [ "category", "payment", "non_payment" ], "title": "Real-Time Decision CardAuthentication MessageCategory", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "prior_authenticated_card_payment_id": { "description": "The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authentications", "nullable": true }, "requestor_authentication_indicator": { "description": "The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction.", "enum": [ "payment_transaction", "recurring_transaction", "installment_transaction", "add_card", "maintain_card", "emv_token_cardholder_verification", "billing_agreement" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication is for a payment transaction.", "The authentication is for a recurring transaction.", "The authentication is for an installment transaction.", "The authentication is for adding a card.", "The authentication is for maintaining a card.", "The authentication is for EMV token cardholder verification.", "The authentication is for a billing agreement." ], "nullable": true }, "requestor_challenge_indicator": { "description": "Indicates whether a challenge is requested for this transaction.", "enum": [ "no_preference", "no_challenge_requested", "challenge_requested_3ds_requestor_preference", "challenge_requested_mandate", "no_challenge_requested_transactional_risk_analysis_already_performed", "no_challenge_requested_data_share_only", "no_challenge_requested_strong_consumer_authentication_already_performed", "no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required", "challenge_requested_whitelist_prompt_requested_if_challenge_required" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No preference.", "No challenge requested.", "Challenge requested, 3DS Requestor preference.", "Challenge requested, mandate.", "No challenge requested, transactional risk analysis already performed.", "No challenge requested, data share only.", "No challenge requested, strong consumer authentication already performed.", "No challenge requested, utilize whitelist exemption if no challenge required.", "Challenge requested, whitelist prompt requested if challenge required." ], "nullable": true }, "requestor_name": { "description": "The name of the 3DS requestor.", "type": "string", "x-documentation-priority": "default" }, "requestor_url": { "description": "The URL of the 3DS requestor.", "type": "string", "x-documentation-priority": "default" }, "shipping_address_city": { "description": "The city of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_country": { "description": "The country of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_line1": { "description": "The first line of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_line2": { "description": "The second line of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_line3": { "description": "The third line of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_postal_code": { "description": "The postal code of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "shipping_address_state": { "description": "The US state of the shipping address associated with this purchase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "three_d_secure_server_transaction_identifier": { "description": "A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction.", "type": "string", "x-documentation-priority": "default" }, "upcoming_card_payment_id": { "description": "The identifier of the Card Payment this authentication attempt will belong to. Available in the API once the card authentication has completed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } }, "required": [ "card_id", "prior_authenticated_card_payment_id", "message_category", "access_control_server_transaction_identifier", "three_d_secure_server_transaction_identifier", "directory_server_transaction_identifier", "device_channel", "cardholder_name", "cardholder_email", "requestor_authentication_indicator", "requestor_challenge_indicator", "requestor_name", "requestor_url", "merchant_category_code", "merchant_acceptor_id", "merchant_name", "merchant_country", "billing_address_line1", "billing_address_line2", "billing_address_line3", "billing_address_city", "billing_address_state", "billing_address_postal_code", "billing_address_country", "shipping_address_line1", "shipping_address_line2", "shipping_address_line3", "shipping_address_city", "shipping_address_state", "shipping_address_postal_code", "shipping_address_country", "account_id", "upcoming_card_payment_id", "decision" ], "title": "Real-Time Decision CardAuthentication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardAuthentications", "nullable": true }, "card_authentication_challenge": { "additionalProperties": false, "description": "Fields related to a 3DS authentication attempt.", "properties": { "account_id": { "description": "The identifier of the Account the card belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "card_id": { "description": "The identifier of the Card that is being tokenized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "card_payment_id": { "description": "The identifier of the Card Payment this authentication challenge attempt belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "one_time_code": { "description": "The one-time code delivered to the cardholder.", "type": "string", "x-documentation-priority": "default" }, "result": { "description": "Whether or not the challenge was delivered to the cardholder.", "enum": [ "success", "failure" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Your application successfully delivered the one-time code to the cardholder.", "Your application was unable to deliver the one-time code to the cardholder." ], "nullable": true } }, "required": [ "card_id", "account_id", "card_payment_id", "one_time_code", "result" ], "title": "Real-Time Decision CardAuthenticationChallenge", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardAuthenticationChallenges", "nullable": true }, "card_authorization": { "additionalProperties": true, "description": "Fields related to a card authorization.", "properties": { "account_id": { "description": "The identifier of the Account the authorization will debit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Real-Time Decision CardAuthorization AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "approval": { "additionalProperties": false, "description": "Present if and only if `decision` is `approve`. Contains information related to the approval of the authorization.", "properties": { "partial_amount": { "description": "If the authorization was partially approved, this field contains the approved amount in the minor unit of the settlement currency.", "type": "integer", "x-documentation-priority": "default", "nullable": true } }, "required": [ "partial_amount" ], "title": "Real-Time Decision CardAuthorization Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Approvals", "nullable": true }, "card_id": { "description": "The identifier of the Card that is being authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "decision": { "description": "Whether or not the authorization was approved.", "enum": [ "approve", "decline" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the authorization.", "Decline the authorization." ], "nullable": true }, "decline": { "additionalProperties": false, "description": "Present if and only if `decision` is `decline`. Contains information related to the reason the authorization was declined.", "properties": { "reason": { "description": "The reason the authorization was declined.", "enum": [ "insufficient_funds", "transaction_never_allowed", "exceeds_approval_limit", "card_temporarily_disabled", "suspected_fraud", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again.", "This type of transaction is not allowed for this card. This transaction should not be retried.", "The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again.", "The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again.", "The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.", "The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly." ] } }, "required": [ "reason" ], "title": "Real-Time Decision CardAuthorization Decline", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Declines", "nullable": true }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "direction": { "description": "The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.", "enum": [ "settlement", "refund" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regular card authorization where funds are debited from the cardholder.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder." ] }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Real-Time Decision CardAuthorization NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Real-Time Decision CardAuthorization NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Real-Time Decision CardAuthorization NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Real-Time Decision CardAuthorization NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "partial_approval_capability": { "description": "Whether or not the authorization supports partial approvals.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This transaction supports partial approvals.", "This transaction does not support partial approvals." ] }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "presentment_amount": { "description": "The amount of the attempted authorization in the currency the card user sees at the time of purchase, in the minor unit of that currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "presentment_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user sees at the time of purchase.", "type": "string", "x-documentation-priority": "default" }, "processing_category": { "description": "The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.", "enum": [ "account_funding", "automatic_fuel_dispenser", "bill_payment", "original_credit", "purchase", "quasi_cash", "refund", "cash_disbursement", "balance_inquiry", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.", "Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.", "A transaction used to pay a bill.", "Original credit transactions are used to send money to a cardholder.", "A regular purchase.", "Quasi-cash transactions represent purchases of items which may be convertible to cash.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.", "Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.", "A balance inquiry transaction is used to check the balance of an account associated with a card.", "The processing category is unknown." ] }, "request_details": { "additionalProperties": false, "description": "Fields specific to the type of request, such as an incremental authorization.", "properties": { "category": { "description": "The type of this request (e.g., an initial authorization or an incremental authorization).", "enum": [ "initial_authorization", "incremental_authorization" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A regular, standalone authorization.", "An incremental request to increase the amount of an existing authorization." ] }, "incremental_authorization": { "additionalProperties": false, "description": "Fields specific to the category `incremental_authorization`.", "properties": { "card_payment_id": { "description": "The card payment for this authorization and increment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "original_card_authorization_id": { "description": "The identifier of the card authorization this request is attempting to increment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Authorizations" } }, "required": [ "card_payment_id", "original_card_authorization_id" ], "title": "Real-Time Decision CardAuthorization RequestDetails IncrementalAuthorization", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "IncrementalAuthorizations", "nullable": true }, "initial_authorization": { "additionalProperties": false, "description": "Fields specific to the category `initial_authorization`.", "properties": {}, "title": "Real-Time Decision CardAuthorization RequestDetails InitialAuthorization", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "InitialAuthorizations", "nullable": true } }, "required": [ "category", "initial_authorization", "incremental_authorization" ], "title": "Real-Time Decision CardAuthorization RequestDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "RequestDetails" }, "settlement_amount": { "description": "The amount of the attempted authorization in the currency it will be settled in. This currency is the same as that of the Account the card belongs to.", "type": "integer", "x-documentation-priority": "default" }, "settlement_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the transaction will be settled in.", "type": "string", "x-documentation-priority": "default" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "upcoming_card_payment_id": { "description": "The identifier of the Card Payment this authorization will belong to. Available in the API once the card authorization has completed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Real-Time Decision CardAuthorization Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Real-Time Decision CardAuthorization Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Real-Time Decision CardAuthorization Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Real-Time Decision CardAuthorization Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "decision", "approval", "decline", "card_id", "upcoming_card_payment_id", "account_id", "presentment_amount", "presentment_currency", "settlement_amount", "settlement_currency", "processing_category", "direction", "partial_approval_capability", "request_details" ], "title": "Real-Time Decision CardAuthorization", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardAuthorizations", "nullable": true }, "card_balance_inquiry": { "additionalProperties": true, "description": "Fields related to a card balance inquiry.", "properties": { "account_id": { "description": "The identifier of the Account the authorization will debit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "additional_amounts": { "additionalProperties": false, "description": "Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.", "properties": { "clinic": { "additionalProperties": false, "description": "The part of this transaction amount that was for clinic-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "dental": { "additionalProperties": false, "description": "The part of this transaction amount that was for dental-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "original": { "additionalProperties": false, "description": "The original pre-authorized amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "prescription": { "additionalProperties": false, "description": "The part of this transaction amount that was for healthcare prescriptions.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "surcharge": { "additionalProperties": false, "description": "The surcharge amount charged for this transaction by the merchant.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_cumulative": { "additionalProperties": false, "description": "The total amount of a series of incremental authorizations, optionally provided.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "total_healthcare": { "additionalProperties": false, "description": "The total amount of healthcare-related additional amounts.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "transit": { "additionalProperties": false, "description": "The part of this transaction amount that was for transit-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "unknown": { "additionalProperties": false, "description": "An unknown additional amount.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true }, "vision": { "additionalProperties": false, "description": "The part of this transaction amount that was for vision-related services.", "properties": { "amount": { "description": "The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts AdditionalAmount", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s", "nullable": true } }, "required": [ "total_healthcare", "total_cumulative", "surcharge", "transit", "vision", "clinic", "dental", "prescription", "original", "unknown" ], "title": "Real-Time Decision CardBalanceInquiry AdditionalAmounts", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "approval": { "additionalProperties": false, "description": "Present if and only if `decision` is `approve`. Contains information related to the approval of the balance inquiry.", "properties": { "balance": { "description": "If the balance inquiry was approved, this field contains the balance in the minor unit of the settlement currency.", "type": "integer", "x-documentation-priority": "default" } }, "required": [ "balance" ], "title": "Real-Time Decision CardBalanceInquiry Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Approvals", "nullable": true }, "card_id": { "description": "The identifier of the Card that is being authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "decision": { "description": "Whether or not the authorization was approved.", "enum": [ "approve", "decline" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the authorization.", "Decline the authorization." ], "nullable": true }, "digital_wallet_token_id": { "description": "If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens", "nullable": true }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_country": { "description": "The country the merchant resides in.", "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "type": "string", "x-documentation-priority": "default" }, "merchant_postal_code": { "description": "The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "merchant_state": { "description": "The state the merchant resides in.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "network_details": { "additionalProperties": false, "description": "Fields specific to the `network`.", "properties": { "category": { "description": "The payment network used to process this card authorization.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa", "Pulse" ] }, "pulse": { "additionalProperties": false, "description": "Fields specific to the `pulse` network.", "properties": {}, "title": "Real-Time Decision CardBalanceInquiry NetworkDetails Pulse", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Pulses", "nullable": true }, "visa": { "additionalProperties": false, "description": "Fields specific to the `visa` network.", "properties": { "electronic_commerce_indicator": { "description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.", "enum": [ "mail_phone_order", "recurring", "installment", "unknown_mail_phone_order", "secure_electronic_commerce", "non_authenticated_security_transaction_at_3ds_capable_merchant", "non_authenticated_security_transaction", "non_secure_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.", "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.", "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.", "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.", "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure", "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.", "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.", "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection." ], "nullable": true }, "point_of_service_entry_mode": { "description": "The method used to enter the cardholder's primary account number and card expiration date.", "enum": [ "unknown", "manual", "magnetic_stripe_no_cvv", "optical_code", "integrated_circuit_card", "contactless", "credential_on_file", "magnetic_stripe", "contactless_magnetic_stripe", "integrated_circuit_card_no_cvv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "Manual key entry", "Magnetic stripe read, without card verification value", "Optical code", "Contact chip card", "Contactless read of chip card", "Transaction initiated using a credential that has previously been stored on file", "Magnetic stripe read", "Contactless read of magnetic stripe data", "Contact chip card, without card verification value" ], "nullable": true }, "stand_in_processing_reason": { "description": "Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ], "nullable": true }, "terminal_entry_capability": { "description": "The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable.", "enum": [ "unknown", "terminal_not_used", "magnetic_stripe", "barcode", "optical_character_recognition", "chip_or_contactless", "contactless_only", "no_capability" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unknown", "No terminal was used for this transaction.", "The terminal can only read magnetic stripes and does not have chip or contactless reading capability.", "The terminal can only read barcodes.", "The terminal can only read cards via Optical Character Recognition.", "The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported.", "The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability.", "The terminal has no card reading capability." ], "nullable": true } }, "required": [ "electronic_commerce_indicator", "point_of_service_entry_mode", "stand_in_processing_reason", "terminal_entry_capability" ], "title": "Real-Time Decision CardBalanceInquiry NetworkDetails Visa", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Visas", "nullable": true } }, "required": [ "category", "visa", "pulse" ], "title": "Real-Time Decision CardBalanceInquiry NetworkDetails", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_identifiers": { "additionalProperties": false, "description": "Network-specific identifiers for a specific request or transaction.", "example": { "authorization_identification_response": null, "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "properties": { "authorization_identification_response": { "description": "The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "retrieval_reference_number": { "description": "A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "transaction_id", "trace_number", "retrieval_reference_number", "authorization_identification_response" ], "title": "Real-Time Decision CardBalanceInquiry NetworkIdentifiers", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.", "type": "integer", "x-documentation-priority": "default", "nullable": true }, "physical_card_id": { "description": "If the authorization was made in-person with a physical card, the Physical Card that was used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards", "nullable": true }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "upcoming_card_payment_id": { "description": "The identifier of the Card Payment this authorization will belong to. Available in the API once the card authorization has completed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "verification": { "additionalProperties": false, "description": "Fields related to verification of cardholder-provided values.", "properties": { "card_verification_code": { "additionalProperties": false, "description": "Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card.", "properties": { "result": { "description": "The result of verifying the Card Verification Code.", "enum": [ "not_checked", "match", "no_match" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No card verification code was provided in the authorization request.", "The card verification code matched the one on file.", "The card verification code did not match the one on file." ] } }, "required": [ "result" ], "title": "Real-Time Decision CardBalanceInquiry Verification CardVerificationCode", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardVerificationCodes" }, "cardholder_address": { "additionalProperties": false, "description": "Cardholder address provided in the authorization request and the address on file we verified it against.", "properties": { "actual_line1": { "description": "Line 1 of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "actual_postal_code": { "description": "The postal code of the address on file for the cardholder.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_line1": { "description": "The cardholder address line 1 provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_postal_code": { "description": "The postal code provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "The address verification result returned to the card network.", "enum": [ "not_checked", "postal_code_match_address_no_match", "postal_code_no_match_address_match", "match", "no_match", "postal_code_match_address_not_checked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "No address information was provided in the authorization request.", "Postal code matches, but the street address does not match or was not provided.", "Postal code does not match, but the street address matches or was not provided.", "Postal code and street address match.", "Postal code and street address do not match.", "Postal code matches, but the street address was not verified. (deprecated)" ] } }, "required": [ "provided_postal_code", "provided_line1", "actual_postal_code", "actual_line1", "result" ], "title": "Real-Time Decision CardBalanceInquiry Verification CardholderAddress", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderAddresses" }, "cardholder_name": { "additionalProperties": false, "description": "Cardholder name provided in the authorization request.", "properties": { "provided_first_name": { "description": "The first name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_last_name": { "description": "The last name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "provided_middle_name": { "description": "The middle name provided for verification in the authorization request.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "provided_first_name", "provided_middle_name", "provided_last_name" ], "title": "Real-Time Decision CardBalanceInquiry Verification CardholderName", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardholderNames", "nullable": true } }, "required": [ "cardholder_address", "cardholder_name", "card_verification_code" ], "title": "Real-Time Decision CardBalanceInquiry Verification", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "s" } }, "required": [ "merchant_acceptor_id", "merchant_descriptor", "merchant_category_code", "terminal_id", "merchant_city", "merchant_state", "merchant_postal_code", "merchant_country", "digital_wallet_token_id", "physical_card_id", "verification", "additional_amounts", "network_identifiers", "network_risk_score", "network_details", "decision", "approval", "card_id", "upcoming_card_payment_id", "account_id" ], "title": "Real-Time Decision CardBalanceInquiry", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "CardBalanceInquiries", "nullable": true }, "category": { "description": "The category of the Real-Time Decision.", "enum": [ "card_authorization_requested", "card_balance_inquiry_requested", "card_authentication_requested", "card_authentication_challenge_requested", "digital_wallet_token_requested", "digital_wallet_authentication_requested" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A card is being authorized.", "A balance inquiry is being made on a card.", "3DS authentication is requested.", "3DS authentication challenge requires cardholder involvement.", "A card is being loaded into a digital wallet.", "A card is being loaded into a digital wallet and requires cardholder authentication." ] }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Real-Time Decision was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "digital_wallet_authentication": { "additionalProperties": false, "description": "Fields related to a digital wallet authentication attempt.", "properties": { "card_id": { "description": "The identifier of the Card that is being tokenized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "channel": { "description": "The channel to send the card user their one-time passcode.", "enum": [ "sms", "email" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Send one-time passcodes over SMS.", "Send one-time passcodes over email." ] }, "digital_wallet": { "description": "The digital wallet app being used.", "enum": [ "apple_pay", "google_pay", "samsung_pay", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Apple Pay", "Google Pay", "Samsung Pay", "Unknown" ] }, "email": { "description": "The email to send the one-time passcode to if `channel` is equal to `email`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "one_time_passcode": { "description": "The one-time passcode to send the card user.", "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "The phone number to send the one-time passcode to if `channel` is equal to `sms`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "result": { "description": "Whether your application successfully delivered the one-time passcode.", "enum": [ "success", "failure" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Your application successfully delivered the one-time passcode to the cardholder.", "Your application failed to deliver the one-time passcode to the cardholder." ], "nullable": true } }, "required": [ "result", "card_id", "digital_wallet", "channel", "one_time_passcode", "phone", "email" ], "title": "Real-Time Decision DigitalWalletAuthentication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "DigitalWalletAuthentications", "nullable": true }, "digital_wallet_token": { "additionalProperties": false, "description": "Fields related to a digital wallet token provisioning attempt.", "properties": { "card_id": { "description": "The identifier of the Card that is being tokenized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "decision": { "description": "Whether or not the provisioning request was approved. This will be null until the real time decision is responded to.", "enum": [ "approve", "decline" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Approve the provisioning request.", "Decline the provisioning request." ], "nullable": true }, "device": { "additionalProperties": false, "description": "Device that is being used to provision the digital wallet token.", "properties": { "identifier": { "description": "ID assigned to the device by the digital wallet provider.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "identifier" ], "title": "Real-Time Decision DigitalWalletToken Device", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Devices" }, "digital_wallet": { "description": "The digital wallet app being used.", "enum": [ "apple_pay", "google_pay", "samsung_pay", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Apple Pay", "Google Pay", "Samsung Pay", "Unknown" ] } }, "required": [ "decision", "card_id", "digital_wallet", "device" ], "title": "Real-Time Decision DigitalWalletToken", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "DigitalWalletTokens", "nullable": true }, "id": { "description": "The Real-Time Decision identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions" }, "status": { "description": "The status of the Real-Time Decision.", "enum": [ "pending", "responded", "timed_out" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The decision is pending action via real-time webhook.", "Your webhook actioned the real-time decision.", "Your webhook failed to respond to the authorization in time." ] }, "timeout_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your application can no longer respond to the Real-Time Decision.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `real_time_decision`.", "enum": [ "real_time_decision" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "timeout_at", "status", "category", "card_authorization", "card_balance_inquiry", "card_authentication", "card_authentication_challenge", "digital_wallet_token", "digital_wallet_authentication" ], "title": "Real-Time Decision", "type": "object", "x-event-categories": [], "x-tag": "Real-Time Decisions", "x-title-plural": "Real-Time Decisions" }, "real_time_payments_transfer": { "additionalProperties": true, "description": "Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "amount": 100, "approval": null, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_name": null, "external_account_id": null, "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "idempotency_key": null, "pending_transaction_id": null, "rejection": null, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "complete", "submission": { "submitted_at": "2020-01-31T23:59:59Z", "transaction_identification": "20220501234567891T1BSLZO01745013025" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "real_time_payments_transfer", "ultimate_creditor_name": null, "ultimate_debtor_name": null, "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_id": { "description": "The Account from which the transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "acknowledgement": { "additionalProperties": false, "description": "If the transfer is acknowledged by the recipient bank, this will contain supplemental details.", "example": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "properties": { "acknowledged_at": { "description": "When the transfer was acknowledged.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "acknowledged_at" ], "title": "Real-Time Payments Transfer Real-Time Payments Transfer Acknowledgement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Real-Time Payments Transfer Acknowledgements", "nullable": true }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "approval": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.", "example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "properties": { "approved_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "approved_by": { "description": "If the Transfer was approved by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "approved_at", "approved_by" ], "title": "Real-Time Payments Transfer Transfer Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Approvals", "nullable": true }, "cancellation": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.", "example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null }, "properties": { "canceled_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "canceled_by": { "description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "canceled_by" ], "title": "Real-Time Payments Transfer Transfer Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Cancellations", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Real-Time Payments Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Real-Time Payments Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Real-Time Payments Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Real-Time Payments Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "creditor_name": { "description": "The name of the transfer's recipient. This is set by the sender when creating the transfer.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real-time payments transfers this is always equal to `USD`.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor_name": { "description": "The name of the transfer's sender. If not provided, defaults to the name of the account's entity.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "external_account_id": { "description": "The identifier of the External Account the transfer was made to, if any.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts", "nullable": true }, "id": { "description": "The Real-Time Payments Transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "rejection": { "additionalProperties": false, "description": "If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.", "example": { "reject_reason_additional_information": null, "reject_reason_code": "account_closed", "rejected_at": "2020-01-31T23:59:59Z" }, "properties": { "reject_reason_additional_information": { "description": "Additional information about the rejection provided by the recipient bank when the `reject_reason_code` is `NARRATIVE`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "reject_reason_code": { "description": "The reason the transfer was rejected as provided by the recipient bank or the Real-Time Payments network.", "enum": [ "account_closed", "account_blocked", "invalid_creditor_account_type", "invalid_creditor_account_number", "invalid_creditor_financial_institution_identifier", "end_customer_deceased", "narrative", "transaction_forbidden", "transaction_type_not_supported", "unexpected_amount", "amount_exceeds_bank_limits", "invalid_creditor_address", "unknown_end_customer", "invalid_debtor_address", "timeout", "unsupported_message_for_recipient", "recipient_connection_not_available", "real_time_payments_suspended", "instructed_agent_signed_off", "processing_error", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.", "The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.", "The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.", "The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.", "The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.", "The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.", "The reason is provided as narrative information in the additional information field.", "Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.", "Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.", "The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.", "The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.", "The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.", "The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.", "The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.", "There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.", "Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.", "The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.", "Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.", "The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.", "The transfer was rejected due to an internal Increase issue. We have been notified.", "Some other error or issue has occurred." ] }, "rejected_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was rejected.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "rejected_at", "reject_reason_code", "reject_reason_additional_information" ], "title": "Real-Time Payments Transfer Real-Time Payments Transfer Rejection", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Real-Time Payments Transfer Rejections", "nullable": true }, "routing_number": { "description": "The destination American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The Account Number the recipient will see as having sent the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "canceled", "pending_reviewing", "requires_attention", "rejected", "pending_submission", "submitted", "complete" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer was rejected by the network or the recipient's bank.", "The transfer is queued to be submitted to Real-Time Payments.", "The transfer has been submitted and is pending a response from Real-Time Payments.", "The transfer has been sent successfully and is complete." ] }, "submission": { "additionalProperties": false, "description": "After the transfer is submitted to Real-Time Payments, this will contain supplemental details.", "example": { "submitted_at": "2020-01-31T23:59:59Z", "transaction_identification": "20220501234567891T1BSLZO01745013025" }, "properties": { "submitted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to The Clearing House.", "format": "date-time", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_identification": { "description": "The Real-Time Payments network identification of the transfer.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "submitted_at", "transaction_identification" ], "title": "Real-Time Payments Transfer Real-Time Payments Transfer Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Real-Time Payments Transfer Submissions", "nullable": true }, "transaction_id": { "description": "The Transaction funding the transfer once it is complete.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.", "enum": [ "real_time_payments_transfer" ], "type": "string", "x-documentation-priority": "default" }, "ultimate_creditor_name": { "description": "The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "ultimate_debtor_name": { "description": "The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unstructured_remittance_information": { "description": "Unstructured information that will show on the recipient's bank statement.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "approval", "cancellation", "status", "created_at", "account_id", "external_account_id", "source_account_number_id", "debtor_name", "creditor_name", "ultimate_creditor_name", "ultimate_debtor_name", "unstructured_remittance_information", "amount", "currency", "account_number", "routing_number", "transaction_id", "pending_transaction_id", "submission", "rejection", "acknowledgement", "created_by", "idempotency_key" ], "title": "Real-Time Payments Transfer", "type": "object", "x-event-categories": [ "real_time_payments_transfer.created", "real_time_payments_transfer.updated" ], "x-tag": "Real-Time Payments Transfers", "x-title-plural": "Real-Time Payments Transfers" }, "real_time_payments_transfer_list": { "additionalProperties": true, "description": "A list of Real-Time Payments Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "amount": 100, "approval": null, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_name": null, "external_account_id": null, "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "idempotency_key": null, "pending_transaction_id": null, "rejection": null, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "complete", "submission": { "submitted_at": "2020-01-31T23:59:59Z", "transaction_identification": "20220501234567891T1BSLZO01745013025" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "real_time_payments_transfer", "ultimate_creditor_name": null, "ultimate_debtor_name": null, "unstructured_remittance_information": "Invoice 29582" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/real_time_payments_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Real-Time Payments Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Real-Time Payments Transfer Lists" }, "return_an_inbound_ach_transfer_parameters": { "additionalProperties": false, "example": { "reason": "payment_stopped" }, "properties": { "reason": { "description": "The reason why this transfer will be returned. The most usual return codes are `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.", "enum": [ "insufficient_funds", "authorization_revoked_by_customer", "payment_stopped", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "beneficiary_or_account_holder_deceased", "credit_entry_refused_by_receiver", "duplicate_entry", "corporate_customer_advised_not_authorized" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01.", "The customer no longer authorizes this transaction. The Nacha return code is R07.", "The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.", "The customer advises that the debit was unauthorized. The Nacha return code is R10.", "The payee is deceased. The Nacha return code is R14.", "The account holder is deceased. The Nacha return code is R15.", "The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.", "The account holder identified this transaction as a duplicate. The Nacha return code is R24.", "The corporate customer no longer authorizes this transaction. The Nacha return code is R29." ] } }, "required": [ "reason" ], "type": "object", "x-event-categories": [] }, "return_an_inbound_check_deposit_parameters": { "additionalProperties": false, "example": { "reason": "altered_or_fictitious" }, "properties": { "reason": { "description": "The reason to return the Inbound Check Deposit.", "enum": [ "altered_or_fictitious", "not_authorized", "duplicate_presentment", "endorsement_missing", "endorsement_irregular", "refer_to_maker" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check was altered or fictitious.", "The check was not authorized.", "The check was a duplicate presentment.", "The check was not endorsed.", "The check was not endorsed by the payee.", "The maker of the check requested its return." ] } }, "required": [ "reason" ], "type": "object", "x-event-categories": [] }, "reverse_an_inbound_wire_transfer_parameters": { "additionalProperties": false, "example": { "reason": "creditor_request" }, "properties": { "reason": { "description": "Reason for the reversal.", "enum": [ "duplicate", "creditor_request", "transaction_forbidden" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The inbound wire transfer was a duplicate.", "The recipient of the wire transfer requested the funds be returned to the sender.", "The account cannot currently receive inbound wires." ] } }, "required": [ "reason" ], "type": "object", "x-event-categories": [] }, "routing_number": { "additionalProperties": false, "description": "Routing numbers are used to identify your bank in a financial transaction.", "example": { "ach_transfers": "supported", "fednow_transfers": "supported", "name": "First Bank of the United States", "real_time_payments_transfers": "supported", "routing_number": "021000021", "type": "routing_number", "wire_transfers": "supported" }, "properties": { "ach_transfers": { "description": "This routing number's support for ACH Transfers.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The routing number can receive this transfer type.", "The routing number cannot receive this transfer type." ] }, "fednow_transfers": { "description": "This routing number's support for FedNow Transfers.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The routing number can receive this transfer type.", "The routing number cannot receive this transfer type." ] }, "name": { "description": "The name of the financial institution belonging to a routing number.", "type": "string", "x-documentation-priority": "default" }, "real_time_payments_transfers": { "description": "This routing number's support for Real-Time Payments Transfers.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The routing number can receive this transfer type.", "The routing number cannot receive this transfer type." ] }, "routing_number": { "description": "The nine digit routing number identifier.", "type": "string", "x-documentation-priority": "default" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `routing_number`.", "enum": [ "routing_number" ], "type": "string", "x-documentation-priority": "default" }, "wire_transfers": { "description": "This routing number's support for Wire Transfers.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The routing number can receive this transfer type.", "The routing number cannot receive this transfer type." ] } }, "required": [ "type", "name", "routing_number", "ach_transfers", "fednow_transfers", "real_time_payments_transfers", "wire_transfers" ], "title": "Routing Number", "type": "object", "x-event-categories": [], "x-tag": "Routing Numbers", "x-title-plural": "Routing Numbers" }, "routing_number_list": { "additionalProperties": true, "description": "A list of Routing Number objects.", "example": { "data": [ { "ach_transfers": "supported", "fednow_transfers": "supported", "name": "First Bank of the United States", "real_time_payments_transfers": "supported", "routing_number": "021000021", "type": "routing_number", "wire_transfers": "supported" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/routing_number" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Routing Number List", "type": "object", "x-event-categories": [], "x-title-plural": "Routing Number Lists" }, "sandbox_adjust_a_check_deposit_parameters": { "additionalProperties": false, "example": {}, "properties": { "amount": { "description": "The adjustment amount in the minor unit of the Check Deposit's currency (e.g., cents). A negative amount means that the funds are being clawed back by the other bank and is a debit to your account. Defaults to the negative of the Check Deposit amount.", "maximum": 1000000000, "minimum": -1000000000, "type": "integer", "x-documentation-priority": "default" }, "reason": { "description": "The reason for the adjustment. Defaults to `non_conforming_item`, which is often used for a low quality image that the recipient wasn't able to handle.", "enum": [ "late_return", "wrong_payee_credit", "adjusted_amount", "non_conforming_item", "paid" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The return was initiated too late and the receiving institution has responded with a Late Return Claim.", "The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.", "The check was deposited with a different amount than what was written on the check.", "The recipient was not able to process the check. This usually happens for e.g., low quality images.", "The check has already been deposited elsewhere and so this is a duplicate." ] } }, "type": "object", "x-event-categories": [] }, "sandbox_advance_the_shipment_status_of_a_physical_card_parameters": { "additionalProperties": false, "example": { "shipment_status": "shipped" }, "properties": { "shipment_status": { "description": "The shipment status to move the Physical Card to.", "enum": [ "pending", "canceled", "submitted", "acknowledged", "rejected", "shipped", "returned", "requires_attention" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card has not yet been shipped.", "The physical card shipment was canceled prior to submission.", "The physical card shipment has been submitted to the card fulfillment provider.", "The physical card shipment has been acknowledged by the card fulfillment provider and will be processed in their next batch.", "The physical card shipment was rejected by the card printer due to an error.", "The physical card has been shipped.", "The physical card shipment was returned to the sender and destroyed by the production facility.", "The physical card shipment requires attention from Increase before progressing." ] } }, "required": [ "shipment_status" ], "type": "object", "x-event-categories": [] }, "sandbox_advance_the_state_of_a_card_dispute_parameters": { "additionalProperties": false, "example": { "network": "visa", "visa": { "accept_user_submission": {}, "action": "accept_user_submission" } }, "properties": { "network": { "description": "The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.", "enum": [ "visa" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa" ] }, "visa": { "additionalProperties": false, "description": "The Visa-specific parameters for the taking action on the dispute. Required if and only if `network` is `visa`.", "properties": { "accept_chargeback": { "additionalProperties": false, "description": "The parameters for accepting the chargeback. Required if and only if `action` is `accept_chargeback`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "accept_user_submission": { "additionalProperties": false, "description": "The parameters for accepting the user submission. Required if and only if `action` is `accept_user_submission`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "action": { "description": "The action to take. Details specific to the action are required under the sub-object with the same identifier as the action.", "enum": [ "accept_chargeback", "accept_user_submission", "decline_user_prearbitration", "receive_merchant_prearbitration", "represent", "request_further_information", "time_out_chargeback", "time_out_merchant_prearbitration", "time_out_representment", "time_out_user_prearbitration" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Simulate the merchant accepting the chargeback. This will move the dispute to a `won` state.", "Accept the user's submission and transmit it to the network. This will move the dispute to a `pending_response` state.", "Simulate the merchant declining the user's pre-arbitration. This will move the dispute to a `lost` state.", "Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state.", "Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.", "Simulate further information being requested from the user. This will move the dispute to a `user_submission_required` state.", "Simulate the merchant timing out responding to the chargeback. This will move the dispute to a `won` state.", "Simulate the user timing out responding to a merchant pre-arbitration. This will move the dispute to a `lost` state.", "Simulate the user timing out responding to a merchant re-presentment. This will move the dispute to a `lost` state.", "Simulate the merchant timing out responding to a user pre-arbitration. This will move the dispute to a `win` state." ] }, "decline_user_prearbitration": { "additionalProperties": false, "description": "The parameters for declining the prearbitration. Required if and only if `action` is `decline_user_prearbitration`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "receive_merchant_prearbitration": { "additionalProperties": false, "description": "The parameters for receiving the prearbitration. Required if and only if `action` is `receive_merchant_prearbitration`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "represent": { "additionalProperties": false, "description": "The parameters for re-presenting the dispute. Required if and only if `action` is `represent`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "request_further_information": { "additionalProperties": false, "description": "The parameters for requesting further information from the user. Required if and only if `action` is `request_further_information`.", "properties": { "reason": { "description": "The reason for requesting further information from the user.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "time_out_chargeback": { "additionalProperties": false, "description": "The parameters for timing out the chargeback. Required if and only if `action` is `time_out_chargeback`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "time_out_merchant_prearbitration": { "additionalProperties": false, "description": "The parameters for timing out the merchant prearbitration. Required if and only if `action` is `time_out_merchant_prearbitration`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "time_out_representment": { "additionalProperties": false, "description": "The parameters for timing out the re-presentment. Required if and only if `action` is `time_out_representment`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "time_out_user_prearbitration": { "additionalProperties": false, "description": "The parameters for timing out the user prearbitration. Required if and only if `action` is `time_out_user_prearbitration`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "action" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "network" ], "type": "object", "x-event-categories": [] }, "sandbox_complete_a_real_time_payments_transfer_parameters": { "additionalProperties": false, "example": {}, "properties": { "rejection": { "additionalProperties": false, "description": "If set, the simulation will reject the transfer.", "properties": { "reject_reason_code": { "description": "The reason code that the simulated rejection will have.", "enum": [ "account_closed", "account_blocked", "invalid_creditor_account_type", "invalid_creditor_account_number", "invalid_creditor_financial_institution_identifier", "end_customer_deceased", "narrative", "transaction_forbidden", "transaction_type_not_supported", "unexpected_amount", "amount_exceeds_bank_limits", "invalid_creditor_address", "unknown_end_customer", "invalid_debtor_address", "timeout", "unsupported_message_for_recipient", "recipient_connection_not_available", "real_time_payments_suspended", "instructed_agent_signed_off", "processing_error", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.", "The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.", "The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.", "The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.", "The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.", "The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.", "The reason is provided as narrative information in the additional information field.", "Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.", "Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.", "The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.", "The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.", "The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.", "The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.", "The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.", "There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.", "Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.", "The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.", "Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.", "The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.", "The transfer was rejected due to an internal Increase issue. We have been notified.", "Some other error or issue has occurred." ] } }, "required": [ "reject_reason_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-event-categories": [] }, "sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization_parameters": { "additionalProperties": false, "example": { "amount": 5000, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }, "properties": { "amount": { "description": "The amount of the fuel_confirmation in minor units in the card authorization's currency.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The identifier of the Card Payment to create a fuel_confirmation on.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } }, "required": [ "card_payment_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_card_authentication_attempt_parameters": { "additionalProperties": false, "example": { "card_id": "card_oubs0hwk5rn6knuecxg2", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_country": "US", "purchase_amount": 1000 }, "properties": { "card_id": { "description": "The identifier of the Card to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "category": { "description": "The category of the card authentication attempt.", "enum": [ "payment_authentication", "non_payment_authentication" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt is for a payment.", "The authentication attempt is not for a payment." ] }, "device_channel": { "description": "The device channel of the card authentication attempt.", "enum": [ "app", "browser", "three_ds_requestor_initiated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The authentication attempt was made from an app.", "The authentication attempt was made from a browser.", "The authentication attempt was initiated by the 3DS Requestor." ] }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_country": { "description": "The country the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_name": { "description": "The name of the merchant", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "purchase_amount": { "description": "The purchase amount in cents.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "card_id" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_card_authentication_challenge_attempt_parameters": { "additionalProperties": false, "example": { "one_time_code": "123456" }, "properties": { "one_time_code": { "description": "The one-time code to be validated.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "one_time_code" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_card_authorization_parameters": { "additionalProperties": false, "example": { "amount": 1000, "card_id": "card_oubs0hwk5rn6knuecxg2", "event_subscription_id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_state": "NY" }, "properties": { "amount": { "description": "The authorization amount in cents.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "authenticated_card_payment_id": { "description": "The identifier of a Card Payment with a `card_authentication` if you want to simulate an authenticated authorization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "card_id": { "description": "The identifier of the Card to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "decline_reason": { "description": "Forces a card decline with a specific reason. No real time decision will be sent.", "enum": [ "account_closed", "card_not_active", "card_canceled", "physical_card_not_active", "entity_not_active", "group_locked", "insufficient_funds", "cvv2_mismatch", "pin_mismatch", "card_expiration_mismatch", "transaction_not_allowed", "breaches_limit", "webhook_declined", "webhook_timed_out", "declined_by_stand_in_processing", "invalid_physical_card", "missing_original_authorization", "invalid_cryptogram", "failed_3ds_authentication", "suspected_card_testing", "suspected_fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account has been closed.", "The Card was not active.", "The Card has been canceled.", "The Physical Card was not active.", "The account's entity was not active.", "The account was inactive.", "The Card's Account did not have a sufficient available balance.", "The given CVV2 did not match the card's value.", "The given PIN did not match the card's value.", "The given expiration date did not match the card's value. Only applies when a CVV2 is present.", "The attempted card transaction is not allowed per Increase's terms.", "The transaction was blocked by a Limit.", "Your application declined the transaction via webhook.", "Your application webhook did not respond without the required timeout.", "Declined by stand-in processing.", "The card read had an invalid CVV or dCVV.", "The original card authorization for this incremental authorization does not exist.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The transaction was declined because the 3DS authentication failed.", "The transaction was suspected to be used by a card tester to test for valid card numbers.", "The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information." ] }, "digital_wallet_token_id": { "description": "The identifier of the Digital Wallet Token to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens" }, "event_subscription_id": { "description": "The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Event Subscriptions" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_country": { "description": "The country the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_state": { "description": "The state the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "network_details": { "additionalProperties": false, "description": "Fields specific to a given card network.", "properties": { "visa": { "additionalProperties": false, "description": "Fields specific to the Visa network.", "properties": { "stand_in_processing_reason": { "description": "The reason code for the stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "visa" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.", "maximum": 99, "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "physical_card_id": { "description": "The identifier of the Physical Card to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" }, "processing_category": { "additionalProperties": false, "description": "Fields specific to a specific type of authorization, such as Automatic Fuel Dispensers, Refund Authorizations, or Cash Disbursements.", "properties": { "category": { "description": "The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser.", "enum": [ "account_funding", "automatic_fuel_dispenser", "bill_payment", "original_credit", "purchase", "quasi_cash", "refund", "cash_disbursement", "balance_inquiry" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts.", "Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction.", "A transaction used to pay a bill.", "Original credit transactions are used to send money to a cardholder.", "A regular purchase.", "Quasi-cash transactions represent purchases of items which may be convertible to cash.", "A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.", "Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.", "A balance inquiry transaction is used to check the balance of an account associated with a card." ] }, "refund": { "additionalProperties": false, "description": "Details related to refund authorizations.", "properties": { "original_card_payment_id": { "description": "The card payment to link this refund to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_card_balance_inquiry_parameters": { "additionalProperties": false, "example": { "balance": 1000000, "card_id": "card_oubs0hwk5rn6knuecxg2", "event_subscription_id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "CITIBANK", "merchant_state": "NY" }, "properties": { "balance": { "description": "The balance amount in cents. The account balance will be used if not provided.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "card_id": { "description": "The identifier of the Card to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "decline_reason": { "description": "Forces a card decline with a specific reason. No real time decision will be sent.", "enum": [ "account_closed", "card_not_active", "card_canceled", "physical_card_not_active", "entity_not_active", "group_locked", "insufficient_funds", "cvv2_mismatch", "pin_mismatch", "card_expiration_mismatch", "transaction_not_allowed", "breaches_limit", "webhook_declined", "webhook_timed_out", "declined_by_stand_in_processing", "invalid_physical_card", "missing_original_authorization", "invalid_cryptogram", "failed_3ds_authentication", "suspected_card_testing", "suspected_fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account has been closed.", "The Card was not active.", "The Card has been canceled.", "The Physical Card was not active.", "The account's entity was not active.", "The account was inactive.", "The Card's Account did not have a sufficient available balance.", "The given CVV2 did not match the card's value.", "The given PIN did not match the card's value.", "The given expiration date did not match the card's value. Only applies when a CVV2 is present.", "The attempted card transaction is not allowed per Increase's terms.", "The transaction was blocked by a Limit.", "Your application declined the transaction via webhook.", "Your application webhook did not respond without the required timeout.", "Declined by stand-in processing.", "The card read had an invalid CVV or dCVV.", "The original card authorization for this incremental authorization does not exist.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The transaction was declined because the 3DS authentication failed.", "The transaction was suspected to be used by a card tester to test for valid card numbers.", "The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information." ] }, "digital_wallet_token_id": { "description": "The identifier of the Digital Wallet Token to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens" }, "event_subscription_id": { "description": "The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Event Subscriptions" }, "merchant_acceptor_id": { "description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_category_code": { "description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_city": { "description": "The city the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_country": { "description": "The country the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_descriptor": { "description": "The merchant descriptor of the merchant the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_state": { "description": "The state the merchant resides in.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "network_details": { "additionalProperties": false, "description": "Fields specific to a given card network.", "properties": { "visa": { "additionalProperties": false, "description": "Fields specific to the Visa network.", "properties": { "stand_in_processing_reason": { "description": "The reason code for the stand-in processing.", "enum": [ "issuer_error", "invalid_physical_card", "invalid_cryptogram", "invalid_cardholder_authentication_verification_value", "internal_visa_error", "merchant_transaction_advisory_service_authentication_required", "payment_fraud_disruption_acquirer_block", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Increase failed to process the authorization in a timely manner.", "The physical card read had an invalid CVV or dCVV.", "The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.", "The 3DS cardholder authentication verification value was invalid.", "An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.", "The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.", "The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.", "An unspecific reason for stand-in processing." ] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "visa" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "network_risk_score": { "description": "The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.", "maximum": 99, "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "physical_card_id": { "description": "The identifier of the Physical Card to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" }, "terminal_id": { "description": "The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "sandbox_create_a_card_purchase_supplement_parameters": { "additionalProperties": false, "example": { "invoice": { "discount_amount": 100, "duty_tax_amount": 200, "order_date": "2023-07-20", "shipping_amount": 300, "shipping_destination_country_code": "US", "shipping_destination_postal_code": "10045", "shipping_source_postal_code": "10045", "shipping_tax_amount": 400, "shipping_tax_rate": "0.2", "unique_value_added_tax_invoice_reference": "12302" }, "line_items": [ { "item_commodity_code": "001", "item_descriptor": "Coffee", "item_quantity": "1", "product_code": "101", "total_amount": 500, "unit_cost": "5", "unit_of_measure_code": "NMB" } ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "invoice": { "additionalProperties": false, "description": "Invoice-level information about the payment.", "properties": { "discount_amount": { "description": "Discount given to cardholder.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "duty_tax_amount": { "description": "Amount of duty taxes.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "order_date": { "description": "Date the order was taken.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "shipping_amount": { "description": "The shipping cost.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "shipping_destination_country_code": { "description": "Country code of the shipping destination.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "shipping_destination_postal_code": { "description": "Postal code of the shipping destination.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "shipping_source_postal_code": { "description": "Postal code of the location being shipped from.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "shipping_tax_amount": { "description": "Taxes paid for freight and shipping.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "shipping_tax_rate": { "description": "Tax rate for freight and shipping.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "unique_value_added_tax_invoice_reference": { "description": "Value added tax invoice reference number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "line_items": { "description": "Line item information, such as individual products purchased.", "items": { "additionalProperties": false, "properties": { "discount_amount": { "description": "Discount amount for this specific line item.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "item_commodity_code": { "description": "Code used to categorize the purchase item.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "item_descriptor": { "description": "Description of the purchase item.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "item_quantity": { "description": "The number of units of the product being purchased.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "product_code": { "description": "Code used to categorize the product being purchased.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "sales_tax_amount": { "description": "Sales tax amount for this line item.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "sales_tax_rate": { "description": "Sales tax rate for this line item.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "total_amount": { "description": "Total amount of all line items.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "unit_cost": { "description": "Cost of line item per unit of measure, in major units.", "pattern": "^-?\\d+(\\.\\d+)?$", "type": "string", "x-documentation-priority": "default" }, "unit_of_measure_code": { "description": "Code indicating unit of measure (gallons, etc.).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the Transaction to create a Card Purchase Supplement for. The Transaction must have a source of type `card_settlement`.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "transaction_id" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_card_token_parameters": { "additionalProperties": false, "example": { "capabilities": [ { "cross_border_push_transfers": "supported", "domestic_push_transfers": "supported", "route": "visa" } ], "expiration": "2020-01-31T23:59:59Z", "last4": "1234", "prefix": "41234567", "primary_account_number_length": 16 }, "properties": { "capabilities": { "description": "The capabilities of the outbound card token.", "items": { "additionalProperties": false, "properties": { "cross_border_push_transfers": { "description": "The cross-border push transfers capability.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The capability is supported.", "The capability is not supported." ] }, "domestic_push_transfers": { "description": "The domestic push transfers capability.", "enum": [ "supported", "not_supported" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The capability is supported.", "The capability is not supported." ] }, "route": { "description": "The route of the capability.", "enum": [ "visa", "mastercard", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa and Interlink", "Mastercard and Maestro", "Pulse" ] } }, "required": [ "route", "domestic_push_transfers", "cross_border_push_transfers" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "expiration": { "description": "The expiration date of the card.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "last4": { "description": "The last 4 digits of the card number.", "maxLength": 4, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "outcome": { "additionalProperties": false, "description": "The outcome to simulate for card push transfers using this token.", "properties": { "decline": { "additionalProperties": false, "description": "If the result is declined, the details of the decline.", "properties": { "reason": { "description": "The reason for the decline.", "enum": [ "do_not_honor", "activity_count_limit_exceeded", "refer_to_card_issuer", "refer_to_card_issuer_special_condition", "invalid_merchant", "pick_up_card", "error", "pick_up_card_special", "invalid_transaction", "invalid_amount", "invalid_account_number", "no_such_issuer", "re_enter_transaction", "no_credit_account", "pick_up_card_lost", "pick_up_card_stolen", "closed_account", "insufficient_funds", "no_checking_account", "no_savings_account", "expired_card", "transaction_not_permitted_to_cardholder", "transaction_not_allowed_at_terminal", "transaction_not_supported_or_blocked_by_issuer", "suspected_fraud", "activity_amount_limit_exceeded", "restricted_card", "security_violation", "transaction_does_not_fulfill_anti_money_laundering_requirement", "blocked_by_cardholder", "blocked_first_use", "credit_issuer_unavailable", "negative_card_verification_value_results", "issuer_unavailable", "financial_institution_cannot_be_found", "transaction_cannot_be_completed", "duplicate_transaction", "system_malfunction", "additional_customer_authentication_required", "surcharge_amount_not_permitted", "decline_for_cvv2_failure", "stop_payment_order", "revocation_of_authorization_order", "revocation_of_all_authorizations_order", "unable_to_locate_record", "file_is_temporarily_unavailable", "incorrect_pin", "allowable_number_of_pin_entry_tries_exceeded", "unable_to_locate_previous_message", "pin_error_found", "cannot_verify_pin", "verification_data_failed", "surcharge_amount_not_supported_by_debit_network_issuer", "cash_service_not_available", "cashback_request_exceeds_issuer_limit", "transaction_amount_exceeds_pre_authorized_approval_amount", "transaction_does_not_qualify_for_visa_pin", "offline_declined", "unable_to_go_online", "valid_account_but_amount_not_supported", "invalid_use_of_merchant_category_code_correct_and_reattempt", "card_authentication_failed" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card issuer has declined the transaction without providing a specific reason.", "The number of transactions for the card has exceeded the limit set by the issuer.", "The card issuer requires the cardholder to contact them for further information regarding the transaction.", "The card issuer requires the cardholder to contact them due to a special condition related to the transaction.", "The merchant is not valid for this transaction.", "The card should be retained by the terminal.", "An error occurred during processing of the transaction.", "The card should be retained by the terminal due to a special condition.", "The transaction is invalid and cannot be processed.", "The amount of the transaction is invalid.", "The account number provided is invalid.", "The issuer of the card could not be found.", "The transaction should be re-entered for processing.", "There is no credit account associated with the card.", "The card should be retained by the terminal because it has been reported lost.", "The card should be retained by the terminal because it has been reported stolen.", "The account associated with the card has been closed.", "There are insufficient funds in the account to complete the transaction.", "There is no checking account associated with the card.", "There is no savings account associated with the card.", "The card has expired and cannot be used for transactions.", "The transaction is not permitted for this cardholder.", "The transaction is not allowed at this terminal.", "The transaction is not supported or has been blocked by the issuer.", "The transaction has been flagged as suspected fraud and cannot be processed.", "The amount of activity on the card has exceeded the limit set by the issuer.", "The card has restrictions that prevent it from being used for this transaction.", "A security violation has occurred, preventing the transaction from being processed.", "The transaction does not meet the anti-money laundering requirements set by the issuer.", "The transaction was blocked by the cardholder.", "The first use of the card has been blocked by the issuer.", "The credit issuer is currently unavailable to process the transaction.", "The card verification value (CVV) results were negative, indicating a potential issue with the card.", "The issuer of the card is currently unavailable to process the transaction.", "The financial institution associated with the card could not be found.", "The transaction cannot be completed due to an unspecified reason.", "The transaction is a duplicate of a previous transaction and cannot be processed again.", "A system malfunction occurred, preventing the transaction from being processed.", "Additional customer authentication is required to complete the transaction.", "The surcharge amount applied to the transaction is not permitted by the issuer.", "The transaction was declined due to a failure in verifying the CVV2 code.", "A stop payment order has been placed on this transaction.", "An order has been placed to revoke authorization for this transaction.", "An order has been placed to revoke all authorizations for this cardholder.", "The record associated with the transaction could not be located.", "The file needed for the transaction is temporarily unavailable.", "The PIN entered for the transaction is incorrect.", "The allowable number of PIN entry tries has been exceeded.", "The previous message associated with the transaction could not be located.", "An error was found with the PIN associated with the transaction.", "The PIN associated with the transaction could not be verified.", "The verification data associated with the transaction has failed.", "The surcharge amount is not supported by the debit network issuer.", "Cash service is not available for this transaction.", "The cashback request exceeds the issuer limit.", "The transaction amount exceeds the pre-authorized approval amount.", "The transaction does not qualify for Visa PIN processing.", "The transaction was declined offline.", "The terminal was unable to go online to process the transaction.", "The account is valid but the transaction amount is not supported.", "The merchant category code was used incorrectly; correct it and reattempt the transaction.", "The card authentication process has failed." ] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "result": { "description": "Whether card push transfers or validations will be approved or declined.", "enum": [ "approve", "decline" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Any card push transfers or validations will be approved.", "Any card push transfers or validations will be declined." ] } }, "required": [ "result" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "prefix": { "description": "The prefix of the card number, usually the first 8 digits.", "maxLength": 8, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "primary_account_number_length": { "description": "The total length of the card number, including prefix and last4.", "maximum": 19, "minimum": 12, "type": "integer", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "sandbox_create_a_digital_wallet_token_request_parameters": { "additionalProperties": false, "example": { "card_id": "card_oubs0hwk5rn6knuecxg2" }, "properties": { "card_id": { "description": "The identifier of the Card to be authorized.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } }, "required": [ "card_id" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_notification_of_change_for_an_ach_transfer_parameters": { "additionalProperties": false, "example": { "change_code": "incorrect_routing_number", "corrected_data": "123456789" }, "properties": { "change_code": { "description": "The reason for the notification of change.", "enum": [ "incorrect_account_number", "incorrect_routing_number", "incorrect_routing_number_and_account_number", "incorrect_transaction_code", "incorrect_account_number_and_transaction_code", "incorrect_routing_number_account_number_and_transaction_code", "incorrect_receiving_depository_financial_institution_identification", "incorrect_individual_identification_number", "addenda_format_error", "incorrect_standard_entry_class_code_for_outbound_international_payment", "misrouted_notification_of_change", "incorrect_trace_number", "incorrect_company_identification_number", "incorrect_identification_number", "incorrectly_formatted_corrected_data", "incorrect_discretionary_data", "routing_number_not_from_original_entry_detail_record", "depository_financial_institution_account_number_not_from_original_entry_detail_record", "incorrect_transaction_code_by_originating_depository_financial_institution" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number was incorrect.", "The routing number was incorrect.", "Both the routing number and the account number were incorrect.", "The transaction code was incorrect. Try changing the `funding` parameter from checking to savings or vice-versa.", "The account number and the transaction code were incorrect.", "The routing number, account number, and transaction code were incorrect.", "The receiving depository financial institution identification was incorrect.", "The individual identification number was incorrect.", "The addenda had an incorrect format.", "The standard entry class code was incorrect for an outbound international payment.", "The notification of change was misrouted.", "The trace number was incorrect.", "The company identification number was incorrect.", "The individual identification number or identification number was incorrect.", "The corrected data was incorrectly formatted.", "The discretionary data was incorrect.", "The routing number was not from the original entry detail record.", "The depository financial institution account number was not from the original entry detail record.", "The transaction code was incorrect, initiated by the originating depository financial institution." ] }, "corrected_data": { "description": "The corrected data for the notification of change (e.g., a new routing number).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "change_code", "corrected_data" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_physical_card_shipment_tracking_update_parameters": { "additionalProperties": false, "example": { "category": "delivered", "city": "New York", "postal_code": "10045", "state": "NY" }, "properties": { "carrier_estimated_delivery_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "category": { "description": "The type of tracking event.", "enum": [ "in_transit", "processed_for_delivery", "delivered", "delivery_issue", "returned_to_sender" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card is in transit.", "The physical card has been processed for delivery.", "The physical card has been delivered.", "There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.", "Delivery failed and the physical card was returned to sender." ] }, "city": { "description": "The city where the event took place.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code where the event took place.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The state where the event took place.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "category" ], "type": "object", "x-event-categories": [] }, "sandbox_create_a_program_parameters": { "additionalProperties": false, "example": { "name": "For Benefit Of" }, "properties": { "bank": { "description": "The bank for the program's accounts, defaults to First Internet Bank.", "enum": [ "core_bank", "first_internet_bank", "grasshopper_bank", "twin_city_bank" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Core Bank", "First Internet Bank of Indiana", "Grasshopper Bank", "Twin City Bank" ] }, "lending_maximum_extendable_credit": { "description": "The maximum extendable credit of the program being added.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "name": { "description": "The name of the program being added.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "reserve_account_id": { "description": "The identifier of the Account the Program should be added to is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, "required": [ "name" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_account_revenue_payment_parameters": { "additionalProperties": false, "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000 }, "properties": { "account_id": { "description": "The identifier of the Account the Account Revenue Payment should be paid to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "accrued_on_account_id": { "description": "The identifier of the Account the account revenue accrued on. Defaults to `account_id`.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The account revenue amount in cents. Must be positive.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "period_end": { "description": "The end of the account revenue period. If not provided, defaults to the current time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "period_start": { "description": "The start of the account revenue period. If not provided, defaults to the current time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_account_statement_parameters": { "additionalProperties": false, "example": { "account_id": "account_in71c4amph0vgo2qllky" }, "properties": { "account_id": { "description": "The identifier of the Account the statement is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, "required": [ "account_id" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_ach_transfer_parameters": { "additionalProperties": false, "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000 }, "properties": { "account_number_id": { "description": "The identifier of the Account Number the inbound ACH Transfer is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "addenda": { "additionalProperties": false, "description": "Additional information to include in the transfer.", "properties": { "category": { "description": "The type of addenda to simulate being sent with the transfer.", "enum": [ "freeform" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unstructured `payment_related_information` passed through with the transfer." ] }, "freeform": { "additionalProperties": false, "description": "Unstructured `payment_related_information` passed through with the transfer.", "properties": { "entries": { "description": "Each entry represents an addendum sent with the transfer.", "items": { "additionalProperties": false, "properties": { "payment_related_information": { "description": "The payment related information passed in the addendum.", "maxLength": 80, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "payment_related_information" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "entries" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "amount": { "description": "The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.", "type": "integer", "x-documentation-priority": "default" }, "company_descriptive_date": { "description": "The description of the date of the transfer.", "maxLength": 6, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_discretionary_data": { "description": "Data associated with the transfer set by the sender.", "maxLength": 20, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_entry_description": { "description": "The description of the transfer set by the sender.", "maxLength": 10, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_id": { "description": "The sender's company ID.", "maxLength": 15, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "company_name": { "description": "The name of the sender.", "maxLength": 16, "minLength": 1, "pattern": "^[ -~]*$", "type": "string", "x-documentation-priority": "default" }, "receiver_id_number": { "description": "The ID of the receiver of the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "receiver_name": { "description": "The name of the receiver of the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "resolve_at": { "description": "The time at which the transfer should be resolved. If not provided will resolve immediately.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "standard_entry_class_code": { "description": "The standard entry class code for the transfer.", "enum": [ "corporate_credit_or_debit", "corporate_trade_exchange", "prearranged_payments_and_deposit", "internet_initiated", "point_of_sale", "telephone_initiated", "customer_initiated", "accounts_receivable", "machine_transfer", "shared_network_transaction", "represented_check", "back_office_conversion", "point_of_purchase", "check_truncation", "destroyed_check", "international_ach_transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Corporate Credit and Debit (CCD).", "Corporate Trade Exchange (CTX).", "Prearranged Payments and Deposits (PPD).", "Internet Initiated (WEB).", "Point of Sale (POS).", "Telephone Initiated (TEL).", "Customer Initiated (CIE).", "Accounts Receivable (ARC).", "Machine Transfer (MTE).", "Shared Network Transaction (SHR).", "Represented Check (RCK).", "Back Office Conversion (BOC).", "Point of Purchase (POP).", "Check Truncation (TRC).", "Destroyed Check (XCK).", "International ACH Transaction (IAT)." ] } }, "required": [ "account_number_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_check_deposit_adjustment_parameters": { "additionalProperties": false, "example": { "amount": 1000 }, "properties": { "amount": { "description": "The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "reason": { "description": "The reason for the adjustment. Defaults to `wrong_payee_credit`.", "enum": [ "late_return", "wrong_payee_credit", "adjusted_amount", "non_conforming_item", "paid" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The return was initiated too late and the receiving institution has responded with a Late Return Claim.", "The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.", "The check was deposited with a different amount than what was written on the check.", "The recipient was not able to process the check. This usually happens for e.g., low quality images.", "The check has already been deposited elsewhere and so this is a duplicate." ] } }, "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_check_deposit_parameters": { "additionalProperties": false, "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000, "check_number": "1234567890" }, "properties": { "account_number_id": { "description": "The identifier of the Account Number the Inbound Check Deposit will be against.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The check amount in cents.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "check_number": { "description": "The check number on the check to be deposited.", "maxLength": 10, "minLength": 1, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" }, "payee_name_analysis": { "description": "Simulate the outcome of [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches). Defaults to `not_evaluated`.", "enum": [ "name_matches", "does_not_match", "not_evaluated" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The details on the check match the recipient name of the check transfer.", "The details on the check do not match the recipient name of the check transfer.", "The payee name analysis was not evaluated." ] } }, "required": [ "account_number_id", "amount", "check_number" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_fednow_transfer_parameters": { "additionalProperties": false, "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000 }, "properties": { "account_number_id": { "description": "The identifier of the Account Number the inbound FedNow Transfer is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The transfer amount in USD cents. Must be positive.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "debtor_account_number": { "description": "The account number of the account that sent the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name provided by the sender of the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The routing number of the account that sent the transfer.", "maxLength": 9, "minLength": 9, "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Additional information included with the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_number_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_mail_item_parameters": { "additionalProperties": true, "example": { "amount": 1000, "lockbox_recipient_id": "lockbox_3xt21ok13q19advds4t5" }, "properties": { "amount": { "description": "The amount of the check to be simulated, in cents.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "contents_file_id": { "description": "The file containing the PDF contents. If not present, a default check image file will be used.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "lockbox_address_id": { "description": "The identifier of the Lockbox Address to simulate inbound mail to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" }, "lockbox_recipient_id": { "description": "The identifier of the Lockbox Recipient to simulate inbound mail to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients" } }, "required": [ "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_real_time_payments_transfer_parameters": { "additionalProperties": true, "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000, "request_for_payment_id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7" }, "properties": { "account_number_id": { "description": "The identifier of the Account Number the inbound Real-Time Payments Transfer is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The transfer amount in USD cents. Must be positive.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "debtor_account_number": { "description": "The account number of the account that sent the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name provided by the sender of the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The routing number of the account that sent the transfer.", "maxLength": 9, "minLength": 9, "type": "string", "x-documentation-priority": "default" }, "request_for_payment_id": { "description": "The identifier of a pending Request for Payment that this transfer will fulfill.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Request for Payments" }, "unstructured_remittance_information": { "description": "Additional information included with the transfer.", "maxLength": 140, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_number_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_wire_drawdown_request_parameters": { "additionalProperties": false, "example": { "amount": 10000, "creditor_account_number": "987654321", "creditor_address_line1": "33 Liberty Street", "creditor_address_line2": "New York, NY, 10045", "creditor_name": "Ian Crease", "creditor_routing_number": "101050001", "currency": "USD", "debtor_account_number": "987654321", "debtor_address_line1": "33 Liberty Street", "debtor_address_line2": "New York, NY, 10045", "debtor_name": "Ian Crease", "debtor_routing_number": "101050001", "instruction_identification": null, "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2" }, "properties": { "amount": { "description": "The amount being requested in cents.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" }, "creditor_account_number": { "description": "The creditor's account number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_address_line1": { "description": "A free-form address field set by the sender representing the first line of the creditor's address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_address_line2": { "description": "A free-form address field set by the sender representing the second line of the creditor's address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_address_line3": { "description": "A free-form address field set by the sender representing the third line of the creditor's address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_name": { "description": "A free-form name field set by the sender representing the creditor's name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_routing_number": { "description": "The creditor's routing number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be \"USD\".", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_account_number": { "description": "The debtor's account number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_address_line1": { "description": "A free-form address field set by the sender representing the first line of the debtor's address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_address_line2": { "description": "A free-form address field set by the sender representing the second line of the debtor's address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_address_line3": { "description": "A free-form address field set by the sender.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "A free-form name field set by the sender representing the debtor's name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The debtor's routing number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "end_to_end_identification": { "description": "A free-form reference string set by the sender, to help identify the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "instruction_identification": { "description": "The sending bank's identifier for the wire transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "recipient_account_number_id": { "description": "The Account Number to which the recipient of this request is being requested to send funds from.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "unique_end_to_end_transaction_reference": { "description": "The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "A free-form message set by the sender.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "recipient_account_number_id", "amount", "currency", "creditor_routing_number", "creditor_account_number" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_inbound_wire_transfer_parameters": { "additionalProperties": false, "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000 }, "properties": { "account_number_id": { "description": "The identifier of the Account Number the inbound Wire Transfer is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The transfer amount in cents. Must be positive.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "creditor_address_line1": { "description": "The sending bank will set creditor_address_line1 in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_address_line2": { "description": "The sending bank will set creditor_address_line2 in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_address_line3": { "description": "The sending bank will set creditor_address_line3 in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "creditor_name": { "description": "The sending bank will set creditor_name in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_address_line1": { "description": "The sending bank will set debtor_address_line1 in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_address_line2": { "description": "The sending bank will set debtor_address_line2 in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_address_line3": { "description": "The sending bank will set debtor_address_line3 in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The sending bank will set debtor_name in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "end_to_end_identification": { "description": "The sending bank will set end_to_end_identification in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "instructing_agent_routing_number": { "description": "The sending bank will set instructing_agent_routing_number in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "instruction_identification": { "description": "The sending bank will set instruction_identification in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "unique_end_to_end_transaction_reference": { "description": "The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "The sending bank will set unstructured_remittance_information in production. You can simulate any value here.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "wire_drawdown_request_id": { "description": "The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests" } }, "required": [ "account_number_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_create_an_interest_payment_parameters": { "additionalProperties": false, "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000 }, "properties": { "account_id": { "description": "The identifier of the Account the Interest Payment should be paid to is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "accrued_on_account_id": { "description": "The identifier of the Account the Interest accrued on. Defaults to `account_id`.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The interest amount in cents. Must be positive.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "period_end": { "description": "The end of the interest period. If not provided, defaults to the current time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "period_start": { "description": "The start of the interest period. If not provided, defaults to the current time.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_expire_a_card_authorization_parameters": { "additionalProperties": false, "example": { "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }, "properties": { "card_payment_id": { "description": "The identifier of the Card Payment to expire.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } }, "required": [ "card_payment_id" ], "type": "object", "x-event-categories": [] }, "sandbox_generate_a_tax_form_export_parameters": { "additionalProperties": false, "example": { "category": "form_1099_int", "form_1099_int": { "account_id": "account_in71c4amph0vgo2qllky" } }, "properties": { "category": { "description": "The type of Export to create.", "enum": [ "form_1099_int" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A PDF of an Internal Revenue Service Form 1099-INT." ] }, "form_1099_int": { "additionalProperties": false, "description": "Options for the created export. Required if `category` is equal to `form_1099_int`.", "properties": { "account_id": { "description": "The identifier of the Account the tax document is for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, "required": [ "account_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-event-categories": [] }, "sandbox_increment_a_card_authorization_parameters": { "additionalProperties": false, "example": { "amount": 500, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }, "properties": { "amount": { "description": "The amount of the increment in minor units in the card authorization's currency.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The identifier of the Card Payment to create an increment on.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" }, "event_subscription_id": { "description": "The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Event Subscriptions" } }, "required": [ "card_payment_id", "amount" ], "type": "object", "x-event-categories": [] }, "sandbox_refund_a_card_transaction_parameters": { "additionalProperties": false, "example": { "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "amount": { "description": "The refund amount in cents. Pulled off the `pending_transaction` or the `transaction` if not provided.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction for the refund authorization. If this is provided, `transaction` must not be provided as a refund with a refund authorized can not be linked to a regular transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions" }, "transaction_id": { "description": "The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "type": "object", "x-event-categories": [] }, "sandbox_return_an_ach_transfer_parameters": { "additionalProperties": false, "example": {}, "properties": { "reason": { "description": "The reason why the Federal Reserve or destination bank returned this transfer. Defaults to `no_account`.", "enum": [ "insufficient_fund", "no_account", "account_closed", "invalid_account_number_structure", "account_frozen_entry_returned_per_ofac_instruction", "credit_entry_refused_by_receiver", "unauthorized_debit_to_consumer_account_using_corporate_sec_code", "corporate_customer_advised_not_authorized", "payment_stopped", "non_transaction_account", "uncollected_funds", "routing_number_check_digit_error", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "amount_field_error", "authorization_revoked_by_customer", "invalid_ach_routing_number", "file_record_edit_criteria", "enr_invalid_individual_name", "returned_per_odfi_request", "limited_participation_dfi", "incorrectly_coded_outbound_international_payment", "account_sold_to_another_dfi", "addenda_error", "beneficiary_or_account_holder_deceased", "customer_advised_not_within_authorization_terms", "corrected_return", "duplicate_entry", "duplicate_return", "enr_duplicate_enrollment", "enr_invalid_dfi_account_number", "enr_invalid_individual_id_number", "enr_invalid_representative_payee_indicator", "enr_invalid_transaction_code", "enr_return_of_enr_entry", "enr_routing_number_check_digit_error", "entry_not_processed_by_gateway", "field_error", "foreign_receiving_dfi_unable_to_settle", "iat_entry_coding_error", "improper_effective_entry_date", "improper_source_document_source_document_presented", "invalid_company_id", "invalid_foreign_receiving_dfi_identification", "invalid_individual_id_number", "item_and_rck_entry_presented_for_payment", "item_related_to_rck_entry_is_ineligible", "mandatory_field_error", "misrouted_dishonored_return", "misrouted_return", "no_errors_found", "non_acceptance_of_r62_dishonored_return", "non_participant_in_iat_program", "permissible_return_entry", "permissible_return_entry_not_accepted", "rdfi_non_settlement", "rdfi_participant_in_check_truncation_program", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "return_not_a_duplicate", "return_of_erroneous_or_reversing_debit", "return_of_improper_credit_entry", "return_of_improper_debit_entry", "return_of_xck_entry", "source_document_presented_for_payment", "state_law_affecting_rck_acceptance", "stop_payment_on_item_related_to_rck_entry", "stop_payment_on_source_document", "timely_original_return", "trace_number_error", "untimely_dishonored_return", "untimely_return" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to \"NSF.\"", "Code R03. The account does not exist or the receiving bank was unable to locate it.", "Code R02. The account is closed at the receiving bank.", "Code R04. The account number is invalid at the receiving bank.", "Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.", "Code R23. The receiving bank refused the credit transfer.", "Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.", "Code R29. The corporate customer at the receiving bank reversed the transfer.", "Code R08. The receiving bank stopped payment on this transfer.", "Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.", "Code R09. The receiving bank account does not have enough available balance for the transfer.", "Code R28. The routing number is incorrect.", "Code R10. The customer at the receiving bank reversed the transfer.", "Code R19. The amount field is incorrect or too large.", "Code R07. The customer revoked their authorization for a previously authorized transfer.", "Code R13. The routing number is invalid.", "Code R17. The receiving bank is unable to process a field in the transfer.", "Code R45. A rare return reason. The individual name field was invalid.", "Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.", "Code R34. The receiving bank's regulatory supervisor has limited their participation in the ACH network.", "Code R85. The outbound international ACH transfer was incorrect.", "Code R12. A rare return reason. The account was sold to another bank.", "Code R25. The addenda record is incorrect or missing.", "Code R15. A rare return reason. The account holder is deceased.", "Code R11. A rare return reason. The customer authorized some payment to the sender, but this payment was not in error.", "Code R74. A rare return reason. Sent in response to a return that was returned with code `field_error`. The latest return should include the corrected field(s).", "Code R24. A rare return reason. The receiving bank received an exact duplicate entry with the same trace number and amount.", "Code R67. A rare return reason. The return this message refers to was a duplicate.", "Code R47. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R43. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R44. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R46. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R41. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R40. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R42. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R84. A rare return reason. The International ACH Transfer cannot be processed by the gateway.", "Code R69. A rare return reason. One or more of the fields in the ACH were malformed.", "Code R83. A rare return reason. The Foreign receiving bank was unable to settle this ACH transfer.", "Code R80. A rare return reason. The International ACH Transfer is malformed.", "Code R18. A rare return reason. The ACH has an improper effective entry date field.", "Code R39. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R21. A rare return reason. The Company ID field of the ACH was invalid.", "Code R82. A rare return reason. The foreign receiving bank identifier for an International ACH Transfer was invalid.", "Code R22. A rare return reason. The Individual ID number field of the ACH was invalid.", "Code R53. A rare return reason. Both the Represented Check (\"RCK\") entry and the original check were presented to the bank.", "Code R51. A rare return reason. The Represented Check (\"RCK\") entry is ineligible.", "Code R26. A rare return reason. The ACH is missing a required field.", "Code R71. A rare return reason. The receiving bank does not recognize the routing number in a dishonored return entry.", "Code R61. A rare return reason. The receiving bank does not recognize the routing number in a return entry.", "Code R76. A rare return reason. Sent in response to a return, the bank does not find the errors alleged by the returning bank.", "Code R77. A rare return reason. The receiving bank does not accept the return of the erroneous debit. The funds are not available at the receiving bank.", "Code R81. A rare return reason. The receiving bank does not accept International ACH Transfers.", "Code R31. A rare return reason. A return that has been agreed to be accepted by the receiving bank, despite falling outside of the usual return timeframe.", "Code R70. A rare return reason. The receiving bank had not approved this return.", "Code R32. A rare return reason. The receiving bank could not settle this transaction.", "Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers.", "Code R14. A rare return reason. The payee is deceased.", "Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate.", "Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it.", "Code R36. A rare return reason. Return of a malformed credit entry.", "Code R35. A rare return reason. Return of a malformed debit entry.", "Code R33. A rare return reason. Return of a destroyed check (\"XCK\") entry.", "Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check (\"RCK\") entry.", "Code R52. A rare return reason. A stop payment was issued on a Represented Check (\"RCK\") entry.", "Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment.", "Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time.", "Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH.", "Code R72. A rare return reason. The dishonored return was sent too late.", "Code R68. A rare return reason. The return was sent too late." ] } }, "type": "object", "x-event-categories": [] }, "sandbox_reverse_a_card_authorization_parameters": { "additionalProperties": false, "example": { "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }, "properties": { "amount": { "description": "The amount of the reversal in minor units in the card authorization's currency. This defaults to the authorization amount.", "maximum": 1000000000, "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "card_payment_id": { "description": "The identifier of the Card Payment to create a reversal on.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } }, "required": [ "card_payment_id" ], "type": "object", "x-event-categories": [] }, "sandbox_settle_a_card_authorization_parameters": { "additionalProperties": false, "example": { "card_id": "card_oubs0hwk5rn6knuecxg2", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4" }, "properties": { "amount": { "description": "The amount to be settled. This defaults to the amount of the Pending Transaction being settled.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "card_id": { "description": "The identifier of the Card to create a settlement on.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" }, "pending_transaction_id": { "description": "The identifier of the Pending Transaction for the Card Authorization you wish to settle.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions" } }, "required": [ "card_id", "pending_transaction_id" ], "type": "object", "x-event-categories": [] }, "sandbox_settle_an_ach_transfer_parameters": { "additionalProperties": false, "example": { "inbound_funds_hold_behavior": "release_immediately" }, "properties": { "inbound_funds_hold_behavior": { "description": "The behavior of the inbound funds hold that is created when the ACH Transfer is settled. If no behavior is specified, the inbound funds hold will be released immediately in order for the funds to be available for use.", "enum": [ "release_immediately", "release_on_default_schedule" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Release the inbound funds hold immediately.", "Release the inbound funds hold on the default schedule." ] } }, "type": "object", "x-event-categories": [] }, "sandbox_simulate_the_status_for_an_entitys_validation_parameters": { "additionalProperties": false, "example": { "issues": [ { "category": "entity_tax_identifier" } ], "status": "invalid" }, "properties": { "issues": { "description": "The validation issues to attach. Only allowed when `status` is `invalid`.", "items": { "additionalProperties": false, "properties": { "category": { "description": "The type of issue.", "enum": [ "entity_tax_identifier", "entity_address", "beneficial_owner_identity", "beneficial_owner_address" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).", "The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).", "A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).", "A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner)." ] } }, "required": [ "category" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "status": { "description": "The validation status to set on the Entity.", "enum": [ "valid", "invalid", "pending" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The submitted data is valid.", "Additional information is required to validate the data.", "The submitted data is being validated." ] } }, "required": [ "status", "issues" ], "type": "object", "x-event-categories": [] }, "sandbox_submit_a_check_deposit_parameters": { "additionalProperties": false, "example": {}, "properties": { "scan": { "additionalProperties": false, "description": "If set, the simulation will use these values for the check's scanned MICR data.", "properties": { "account_number": { "description": "The account number to be returned in the check deposit's scan data.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "auxiliary_on_us": { "description": "The auxiliary on-us data to be returned in the check deposit's scan data.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "routing_number": { "description": "The routing number to be returned in the check deposit's scan data.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "account_number", "routing_number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-event-categories": [] }, "stop_payment_on_a_check_transfer_parameters": { "additionalProperties": false, "example": { "reason": "mail_delivery_failed" }, "properties": { "reason": { "description": "The reason why this transfer should be stopped.", "enum": [ "mail_delivery_failed", "not_authorized", "valid_until_date_passed", "unknown" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check could not be delivered.", "The check was not authorized.", "The check was stopped for `valid_until_date` being in the past.", "The check was stopped for another reason." ] } }, "type": "object", "x-event-categories": [] }, "submit_a_user_submission_for_a_card_dispute_parameters": { "additionalProperties": true, "example": { "network": "visa", "visa": { "category": "merchant_prearbitration_decline", "merchant_prearbitration_decline": { "reason": "The pre-arbitration received from the merchantdoes not explain how they obtained permission to charge the card." } } }, "properties": { "amount": { "description": "The adjusted monetary amount of the part of the transaction that is being disputed. This is optional and will default to the most recent amount provided. If provided, the amount must be less than or equal to the amount of the transaction.", "minimum": 1, "type": "integer", "x-documentation-priority": "default" }, "attachment_files": { "description": "The files to be attached to the user submission.", "items": { "additionalProperties": false, "properties": { "file_id": { "description": "The ID of the file to be attached. The file must have a `purpose` of `card_dispute_attachment`.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "explanation": { "description": "The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "network": { "description": "The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.", "enum": [ "visa" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa" ] }, "visa": { "additionalProperties": false, "description": "The Visa-specific parameters for the dispute. Required if and only if `network` is `visa`.", "properties": { "category": { "description": "The category of the user submission. Details specific to the category are required under the sub-object with the same identifier as the category.", "enum": [ "chargeback", "merchant_prearbitration_decline", "user_prearbitration" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Chargeback.", "Merchant pre-arbitration decline.", "User pre-arbitration." ] }, "chargeback": { "additionalProperties": false, "description": "The chargeback details for the user submission. Required if and only if `category` is `chargeback`.", "properties": { "authorization": { "additionalProperties": false, "description": "Authorization. Required if and only if `category` is `authorization`.", "properties": { "account_status": { "description": "Account status.", "enum": [ "account_closed", "credit_problem", "fraud" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account closed.", "Credit problem.", "Fraud." ] } }, "required": [ "account_status" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "category": { "description": "Category.", "enum": [ "authorization", "consumer_canceled_merchandise", "consumer_canceled_recurring_transaction", "consumer_canceled_services", "consumer_counterfeit_merchandise", "consumer_credit_not_processed", "consumer_damaged_or_defective_merchandise", "consumer_merchandise_misrepresentation", "consumer_merchandise_not_as_described", "consumer_merchandise_not_received", "consumer_non_receipt_of_cash", "consumer_original_credit_transaction_not_accepted", "consumer_quality_merchandise", "consumer_quality_services", "consumer_services_misrepresentation", "consumer_services_not_as_described", "consumer_services_not_received", "fraud", "processing_error" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Authorization.", "Consumer: canceled merchandise.", "Consumer: canceled recurring transaction.", "Consumer: canceled services.", "Consumer: counterfeit merchandise.", "Consumer: credit not processed.", "Consumer: damaged or defective merchandise.", "Consumer: merchandise misrepresentation.", "Consumer: merchandise not as described.", "Consumer: merchandise not received.", "Consumer: non-receipt of cash.", "Consumer: Original Credit Transaction (OCT) not accepted.", "Consumer: merchandise quality issue.", "Consumer: services quality issue.", "Consumer: services misrepresentation.", "Consumer: services not as described.", "Consumer: services not received.", "Fraud.", "Processing error." ] }, "consumer_canceled_merchandise": { "additionalProperties": false, "description": "Canceled merchandise. Required if and only if `category` is `consumer_canceled_merchandise`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "canceled_prior_to_ship_date": { "description": "Canceled prior to ship date.", "enum": [ "canceled_prior_to_ship_date", "not_canceled_prior_to_ship_date" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Canceled prior to ship date.", "Not canceled prior to ship date." ] }, "cancellation_policy_provided": { "description": "Cancellation policy provided.", "enum": [ "not_provided", "provided" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not provided.", "Provided." ] }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at", "canceled_prior_to_ship_date", "cancellation_policy_provided", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_or_expected_at": { "description": "Received or expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "purchase_explanation", "received_or_expected_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_canceled_recurring_transaction": { "additionalProperties": false, "description": "Canceled recurring transaction. Required if and only if `category` is `consumer_canceled_recurring_transaction`.", "properties": { "cancellation_target": { "description": "Cancellation target.", "enum": [ "account", "transaction" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account.", "Transaction." ] }, "merchant_contact_methods": { "additionalProperties": false, "description": "Merchant contact methods.", "properties": { "application_name": { "description": "Application name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "call_center_phone_number": { "description": "Call center phone number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "email_address": { "description": "Email address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "in_person_address": { "description": "In person address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "mailing_address": { "description": "Mailing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "text_phone_number": { "description": "Text phone number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "other_form_of_payment_explanation": { "description": "Other form of payment explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "transaction_or_account_canceled_at": { "description": "Transaction or account canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_target", "merchant_contact_methods", "transaction_or_account_canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_canceled_services": { "additionalProperties": false, "description": "Canceled services. Required if and only if `category` is `consumer_canceled_services`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "cancellation_policy_provided": { "description": "Cancellation policy provided.", "enum": [ "not_provided", "provided" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not provided.", "Provided." ] }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at", "cancellation_policy_provided", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "contracted_at": { "description": "Contracted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "guaranteed_reservation": { "additionalProperties": false, "description": "Guaranteed reservation explanation. Required if and only if `service_type` is `guaranteed_reservation`.", "properties": { "explanation": { "description": "Explanation.", "enum": [ "cardholder_canceled_prior_to_service", "cardholder_cancellation_attempt_within_24_hours_of_confirmation", "merchant_billed_no_show" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder canceled prior to service.", "Cardholder cancellation attempt within 24 hours of confirmation.", "Merchant billed for no-show." ] } }, "required": [ "explanation" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "other": { "additionalProperties": false, "description": "Other service type explanation. Required if and only if `service_type` is `other`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "service_type": { "description": "Service type.", "enum": [ "guaranteed_reservation", "other", "timeshare" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Guaranteed reservation.", "Other.", "Timeshare." ] }, "timeshare": { "additionalProperties": false, "description": "Timeshare explanation. Required if and only if `service_type` is `timeshare`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "cardholder_cancellation", "contracted_at", "merchant_resolution_attempted", "purchase_explanation", "service_type" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_counterfeit_merchandise": { "additionalProperties": false, "description": "Counterfeit merchandise. Required if and only if `category` is `consumer_counterfeit_merchandise`.", "properties": { "counterfeit_explanation": { "description": "Counterfeit explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "disposition_explanation": { "description": "Disposition explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "order_explanation": { "description": "Order explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "counterfeit_explanation", "disposition_explanation", "order_explanation", "received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_credit_not_processed": { "additionalProperties": false, "description": "Credit not processed. Required if and only if `category` is `consumer_credit_not_processed`.", "properties": { "canceled_or_returned_at": { "description": "Canceled or returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "credit_expected_at": { "description": "Credit expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_damaged_or_defective_merchandise": { "additionalProperties": false, "description": "Damaged or defective merchandise. Required if and only if `category` is `consumer_damaged_or_defective_merchandise`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "order_and_issue_explanation": { "description": "Order and issue explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "order_and_issue_explanation", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_merchandise_misrepresentation": { "additionalProperties": false, "description": "Merchandise misrepresentation. Required if and only if `category` is `consumer_merchandise_misrepresentation`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "misrepresentation_explanation": { "description": "Misrepresentation explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "misrepresentation_explanation", "purchase_explanation", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_merchandise_not_as_described": { "additionalProperties": false, "description": "Merchandise not as described. Required if and only if `category` is `consumer_merchandise_not_as_described`.", "properties": { "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "merchant_resolution_attempted", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_merchandise_not_received": { "additionalProperties": false, "description": "Merchandise not received. Required if and only if `category` is `consumer_merchandise_not_received`.", "properties": { "cancellation_outcome": { "description": "Cancellation outcome.", "enum": [ "cardholder_cancellation_prior_to_expected_receipt", "merchant_cancellation", "no_cancellation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder cancellation prior to expected receipt.", "Merchant cancellation.", "No cancellation." ] }, "cardholder_cancellation_prior_to_expected_receipt": { "additionalProperties": false, "description": "Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "delayed": { "additionalProperties": false, "description": "Delayed. Required if and only if `delivery_issue` is `delayed`.", "properties": { "explanation": { "description": "Explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempted_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "merchant_received_return_at", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "explanation", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "delivered_to_wrong_location": { "additionalProperties": false, "description": "Delivered to wrong location. Required if and only if `delivery_issue` is `delivered_to_wrong_location`.", "properties": { "agreed_location": { "description": "Agreed location.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "agreed_location" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "delivery_issue": { "description": "Delivery issue.", "enum": [ "delayed", "delivered_to_wrong_location" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Delayed.", "Delivered to wrong location." ] }, "last_expected_receipt_at": { "description": "Last expected receipt at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_cancellation": { "additionalProperties": false, "description": "Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "no_cancellation": { "additionalProperties": false, "description": "No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_explanation": { "description": "Purchase information and explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_outcome", "delivery_issue", "last_expected_receipt_at", "merchant_resolution_attempted", "purchase_info_and_explanation" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_non_receipt_of_cash": { "additionalProperties": false, "description": "Non-receipt of cash. Required if and only if `category` is `consumer_non_receipt_of_cash`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_original_credit_transaction_not_accepted": { "additionalProperties": false, "description": "Original Credit Transaction (OCT) not accepted. Required if and only if `category` is `consumer_original_credit_transaction_not_accepted`.", "properties": { "explanation": { "description": "Explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "enum": [ "prohibited_by_local_laws_or_regulation", "recipient_refused" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Prohibited by local laws or regulation.", "Recipient refused." ] } }, "required": [ "explanation", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_quality_merchandise": { "additionalProperties": false, "description": "Merchandise quality issue. Required if and only if `category` is `consumer_quality_merchandise`.", "properties": { "expected_at": { "description": "Expected at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "not_returned": { "additionalProperties": false, "description": "Not returned. Required if and only if `return_outcome` is `not_returned`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "ongoing_negotiations": { "additionalProperties": false, "description": "Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations.", "properties": { "explanation": { "description": "Explanation of the previous ongoing negotiations between the cardholder and merchant.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "issuer_first_notified_at": { "description": "Date the cardholder first notified the issuer of the dispute.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "started_at": { "description": "Started at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "issuer_first_notified_at", "started_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_quality_issue": { "description": "Purchase information and quality issue.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "return_attempted": { "additionalProperties": false, "description": "Return attempted. Required if and only if `return_outcome` is `return_attempted`.", "properties": { "attempt_explanation": { "description": "Attempt explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "attempt_reason": { "description": "Attempt reason.", "enum": [ "merchant_not_responding", "no_return_authorization_provided", "no_return_instructions", "requested_not_to_return", "return_not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Merchant not responding.", "No return authorization provided.", "No return instructions.", "Requested not to return.", "Return not accepted." ] }, "attempted_at": { "description": "Attempted at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchandise_disposition": { "description": "Merchandise disposition.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "attempt_explanation", "attempt_reason", "attempted_at", "merchandise_disposition" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "return_outcome": { "description": "Return outcome.", "enum": [ "not_returned", "returned", "return_attempted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not returned.", "Returned.", "Return attempted." ] }, "returned": { "additionalProperties": false, "description": "Returned. Required if and only if `return_outcome` is `returned`.", "properties": { "merchant_received_return_at": { "description": "Merchant received return at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "other_explanation": { "description": "Other explanation. Required if and only if the return method is `other`.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "return_method": { "description": "Return method.", "enum": [ "dhl", "face_to_face", "fedex", "other", "postal_service", "ups" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "DHL.", "Face-to-face.", "FedEx.", "Other.", "Postal service.", "UPS." ] }, "returned_at": { "description": "Returned at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "tracking_number": { "description": "Tracking number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "return_method", "returned_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "expected_at", "merchant_resolution_attempted", "purchase_info_and_quality_issue", "received_at", "return_outcome" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_quality_services": { "additionalProperties": false, "description": "Services quality issue. Required if and only if `category` is `consumer_quality_services`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "cardholder_paid_to_have_work_redone": { "description": "Cardholder paid to have work redone.", "enum": [ "did_not_pay_to_have_work_redone", "paid_to_have_work_redone" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder did not pay to have work redone.", "Cardholder paid to have work redone." ] }, "non_fiat_currency_or_non_fungible_token_related_and_not_matching_description": { "description": "Non-fiat currency or non-fungible token related and not matching description.", "enum": [ "not_related", "related" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not related.", "Related." ] }, "ongoing_negotiations": { "additionalProperties": false, "description": "Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations.", "properties": { "explanation": { "description": "Explanation of the previous ongoing negotiations between the cardholder and merchant.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "issuer_first_notified_at": { "description": "Date the cardholder first notified the issuer of the dispute.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "started_at": { "description": "Started at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "explanation", "issuer_first_notified_at", "started_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_quality_issue": { "description": "Purchase information and quality issue.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "restaurant_food_related": { "description": "Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814.", "enum": [ "not_related", "related" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Not related.", "Related." ] }, "services_received_at": { "description": "Services received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "non_fiat_currency_or_non_fungible_token_related_and_not_matching_description", "purchase_info_and_quality_issue", "services_received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_services_misrepresentation": { "additionalProperties": false, "description": "Services misrepresentation. Required if and only if `category` is `consumer_services_misrepresentation`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "misrepresentation_explanation": { "description": "Misrepresentation explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "purchase_explanation": { "description": "Purchase explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "merchant_resolution_attempted", "misrepresentation_explanation", "purchase_explanation", "received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_services_not_as_described": { "additionalProperties": false, "description": "Services not as described. Required if and only if `category` is `consumer_services_not_as_described`.", "properties": { "cardholder_cancellation": { "additionalProperties": false, "description": "Cardholder cancellation.", "properties": { "accepted_by_merchant": { "description": "Accepted by merchant.", "enum": [ "accepted", "not_accepted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Accepted.", "Not accepted." ] }, "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "accepted_by_merchant", "canceled_at", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "explanation": { "description": "Explanation of what was ordered and was not as described.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "received_at": { "description": "Received at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "cardholder_cancellation", "explanation", "merchant_resolution_attempted", "received_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "consumer_services_not_received": { "additionalProperties": false, "description": "Services not received. Required if and only if `category` is `consumer_services_not_received`.", "properties": { "cancellation_outcome": { "description": "Cancellation outcome.", "enum": [ "cardholder_cancellation_prior_to_expected_receipt", "merchant_cancellation", "no_cancellation" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Cardholder cancellation prior to expected receipt.", "Merchant cancellation.", "No cancellation." ] }, "cardholder_cancellation_prior_to_expected_receipt": { "additionalProperties": false, "description": "Cardholder cancellation prior to expected receipt. Required if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "reason": { "description": "Reason.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "last_expected_receipt_at": { "description": "Last expected receipt at.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "merchant_cancellation": { "additionalProperties": false, "description": "Merchant cancellation. Required if and only if `cancellation_outcome` is `merchant_cancellation`.", "properties": { "canceled_at": { "description": "Canceled at.", "format": "date", "type": "string", "x-documentation-priority": "default" } }, "required": [ "canceled_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "no_cancellation": { "additionalProperties": false, "description": "No cancellation. Required if and only if `cancellation_outcome` is `no_cancellation`.", "properties": {}, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "purchase_info_and_explanation": { "description": "Purchase information and explanation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "cancellation_outcome", "last_expected_receipt_at", "merchant_resolution_attempted", "purchase_info_and_explanation" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "fraud": { "additionalProperties": false, "description": "Fraud. Required if and only if `category` is `fraud`.", "properties": { "fraud_type": { "description": "Fraud type.", "enum": [ "account_or_credentials_takeover", "card_not_received_as_issued", "fraudulent_application", "fraudulent_use_of_account_number", "incorrect_processing", "issuer_reported_counterfeit", "lost", "manipulation_of_account_holder", "merchant_misrepresentation", "miscellaneous", "stolen" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account or credentials takeover.", "Card not received as issued.", "Fraudulent application.", "Fraudulent use of account number.", "Incorrect processing.", "Issuer reported counterfeit.", "Lost.", "Manipulation of account holder.", "Merchant misrepresentation.", "Miscellaneous.", "Stolen." ] } }, "required": [ "fraud_type" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "processing_error": { "additionalProperties": false, "description": "Processing error. Required if and only if `category` is `processing_error`.", "properties": { "duplicate_transaction": { "additionalProperties": false, "description": "Duplicate transaction. Required if and only if `error_reason` is `duplicate_transaction`.", "properties": { "other_transaction_id": { "description": "Other transaction ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "other_transaction_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "error_reason": { "description": "Error reason.", "enum": [ "duplicate_transaction", "incorrect_amount", "paid_by_other_means" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Duplicate transaction.", "Incorrect amount.", "Paid by other means." ] }, "incorrect_amount": { "additionalProperties": false, "description": "Incorrect amount. Required if and only if `error_reason` is `incorrect_amount`.", "properties": { "expected_amount": { "description": "Expected amount.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "expected_amount" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_resolution_attempted": { "description": "Merchant resolution attempted.", "enum": [ "attempted", "prohibited_by_local_law" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Attempted.", "Prohibited by local law." ] }, "paid_by_other_means": { "additionalProperties": false, "description": "Paid by other means. Required if and only if `error_reason` is `paid_by_other_means`.", "properties": { "other_form_of_payment_evidence": { "description": "Other form of payment evidence.", "enum": [ "canceled_check", "card_transaction", "cash_receipt", "other", "statement", "voucher" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Canceled check.", "Card transaction.", "Cash receipt.", "Other.", "Statement.", "Voucher." ] }, "other_transaction_id": { "description": "Other transaction ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "other_form_of_payment_evidence" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "error_reason", "merchant_resolution_attempted" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_prearbitration_decline": { "additionalProperties": false, "description": "The merchant pre-arbitration decline details for the user submission. Required if and only if `category` is `merchant_prearbitration_decline`.", "properties": { "reason": { "description": "The reason for declining the merchant's pre-arbitration request.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "user_prearbitration": { "additionalProperties": false, "description": "The user pre-arbitration details for the user submission. Required if and only if `category` is `user_prearbitration`.", "properties": { "category_change": { "additionalProperties": false, "description": "Category change details for the pre-arbitration request. Should only be populated if the category of the dispute is being changed as part of the pre-arbitration request.", "properties": { "category": { "enum": [ "authorization", "consumer_canceled_merchandise", "consumer_canceled_recurring_transaction", "consumer_canceled_services", "consumer_counterfeit_merchandise", "consumer_credit_not_processed", "consumer_damaged_or_defective_merchandise", "consumer_merchandise_misrepresentation", "consumer_merchandise_not_as_described", "consumer_merchandise_not_received", "consumer_non_receipt_of_cash", "consumer_original_credit_transaction_not_accepted", "consumer_quality_merchandise", "consumer_quality_services", "consumer_services_misrepresentation", "consumer_services_not_as_described", "consumer_services_not_received", "fraud", "processing_error" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Authorization.", "Consumer: canceled merchandise.", "Consumer: canceled recurring transaction.", "Consumer: canceled services.", "Consumer: counterfeit merchandise.", "Consumer: credit not processed.", "Consumer: damaged or defective merchandise.", "Consumer: merchandise misrepresentation.", "Consumer: merchandise not as described.", "Consumer: merchandise not received.", "Consumer: non-receipt of cash.", "Consumer: Original Credit Transaction (OCT) not accepted.", "Consumer: merchandise quality issue.", "Consumer: services quality issue.", "Consumer: services misrepresentation.", "Consumer: services not as described.", "Consumer: services not received.", "Fraud.", "Processing error." ] }, "reason": { "description": "The reason for the category change.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "category", "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "reason": { "description": "The reason for the pre-arbitration request.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "reason" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "network" ], "type": "object", "x-event-categories": [] }, "swift_transfer": { "additionalProperties": false, "description": "Swift Transfers send funds internationally.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "bank_identification_code": "ECBFDEFFTPP", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_address": { "city": "Frankfurt", "country": "DE", "line1": "Sonnemannstrasse 20", "line2": null, "postal_code": "60314", "state": null }, "creditor_name": "Ian Crease", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": null }, "debtor_name": "National Phonograph Company", "id": "swift_transfer_29h21xkng03788zwd3fh", "idempotency_key": null, "instructed_amount": 100, "instructed_currency": "USD", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "routing_number": null, "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "initiated", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "swift_transfer", "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a", "unstructured_remittance_information": "Remittance information" }, "properties": { "account_id": { "description": "The Account to which the transfer belongs.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The creditor's account number.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "bank_identification_code": { "description": "The bank identification code (BIC) of the creditor.", "type": "string", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Swift Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Swift Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Swift Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Swift Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators" }, "creditor_address": { "additionalProperties": false, "description": "The creditor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The state, province, or region of the address. Required in certain countries.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "postal_code", "country" ], "title": "Swift Transfer Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "creditor_name": { "description": "The creditor's name.", "type": "string", "x-documentation-priority": "default" }, "debtor_address": { "additionalProperties": false, "description": "The debtor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The ZIP or postal code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The state, province, or region of the address. Required in certain countries.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "postal_code", "country" ], "title": "Swift Transfer Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "debtor_name": { "description": "The debtor's name.", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Swift transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "instructed_amount": { "description": "The amount that was instructed to be transferred in minor units of the `instructed_currency`.", "type": "integer", "x-documentation-priority": "default" }, "instructed_currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the instructed amount.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "United States Dollar" ] }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "routing_number": { "description": "The creditor's bank account routing or transit number. Required in certain countries.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "source_account_number_id": { "description": "The Account Number included in the transfer as the debtor's account number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "canceled", "pending_reviewing", "requires_attention", "pending_initiating", "initiated", "rejected", "returned" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is pending initiation.", "The transfer has been initiated.", "The transfer has been rejected by Increase.", "The transfer has been returned." ] }, "transaction_id": { "description": "The ID for the transaction funding the transfer. This will be populated after the transfer is initiated.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `swift_transfer`.", "enum": [ "swift_transfer" ], "type": "string", "x-documentation-priority": "default" }, "unique_end_to_end_transaction_reference": { "description": "The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) for the transfer.", "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "The unstructured remittance information that was included with the transfer.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "created_by", "amount", "instructed_amount", "instructed_currency", "account_number", "bank_identification_code", "routing_number", "creditor_name", "creditor_address", "debtor_name", "debtor_address", "unstructured_remittance_information", "unique_end_to_end_transaction_reference", "account_id", "source_account_number_id", "status", "transaction_id", "pending_transaction_id", "idempotency_key" ], "title": "Swift Transfer", "type": "object", "x-event-categories": [ "swift_transfer.created", "swift_transfer.updated" ], "x-tag": "Swift Transfers", "x-title-plural": "Swift Transfers" }, "swift_transfer_list": { "additionalProperties": true, "description": "A list of Swift Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "bank_identification_code": "ECBFDEFFTPP", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_address": { "city": "Frankfurt", "country": "DE", "line1": "Sonnemannstrasse 20", "line2": null, "postal_code": "60314", "state": null }, "creditor_name": "Ian Crease", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": null }, "debtor_name": "National Phonograph Company", "id": "swift_transfer_29h21xkng03788zwd3fh", "idempotency_key": null, "instructed_amount": 100, "instructed_currency": "USD", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "routing_number": null, "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "initiated", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "swift_transfer", "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a", "unstructured_remittance_information": "Remittance information" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/swift_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Swift Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Swift Transfer Lists" }, "transaction": { "additionalProperties": true, "description": "Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).", "example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "inbound_ach_transfer", "inbound_ach_transfer": { "addenda": null, "amount": 100, "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" } }, "type": "transaction" }, "properties": { "account_id": { "description": "The identifier for the Account the Transaction belongs to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occurred.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "description": { "description": "An informational message describing this transaction. Use the fields in `source` to get more detailed information. This field appears as the line-item on the statement.", "type": "string", "x-documentation-priority": "default" }, "id": { "description": "The Transaction identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "route_id": { "description": "The identifier for the route this Transaction came through. Routes are things like cards and ACH details.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "route_type": { "description": "The type of the route this Transaction came through.", "enum": [ "account_number", "card", "lockbox" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An Account Number.", "A Card.", "A Lockbox." ], "nullable": true }, "source": { "additionalProperties": true, "description": "This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.", "example": { "category": "inbound_ach_transfer", "inbound_ach_transfer": { "addenda": null, "amount": 100, "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" } }, "properties": { "account_revenue_payment": { "additionalProperties": true, "description": "An Account Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `account_revenue_payment`. An Account Revenue Payment represents a payment made to an account from the bank. Account revenue is a type of non-interest income.", "example": { "accrued_on_account_id": "account_in71c4amph0vgo2qllky", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00" }, "properties": { "accrued_on_account_id": { "description": "The account on which the account revenue was accrued.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "period_end": { "description": "The end of the period for which this transaction paid account revenue.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "period_start": { "description": "The start of the period for which this transaction paid account revenue.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "period_start", "period_end", "accrued_on_account_id" ], "title": "Transaction Transaction Source Account Revenue Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Account Revenue Payments", "nullable": true }, "account_transfer_intention": { "additionalProperties": true, "description": "An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`. Two Account Transfer Intentions are created from each Account Transfer. One decrements the source account, and the other increments the destination account.", "example": { "amount": 100, "currency": "USD", "description": "INVOICE 2468", "destination_account_id": "account_uf16sut2ct5bevmq3eh", "source_account_id": "account_in71c4amph0vgo2qllky", "transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n" }, "properties": { "amount": { "description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "description": { "description": "The description you chose to give the transfer.", "type": "string", "x-documentation-priority": "default" }, "destination_account_id": { "description": "The identifier of the Account to where the Account Transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "source_account_id": { "description": "The identifier of the Account from where the Account Transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "transfer_id": { "description": "The identifier of the Account Transfer that led to this Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Transfers" } }, "required": [ "amount", "currency", "description", "destination_account_id", "source_account_id", "transfer_id" ], "title": "Transaction Transaction Source Account Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Account Transfer Intentions", "nullable": true }, "ach_transfer_intention": { "additionalProperties": true, "description": "An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`. An ACH Transfer Intention is created from an ACH Transfer. It reflects the intention to move money into or out of an Increase account via the ACH network.", "example": { "account_number": "987654321", "amount": 100, "routing_number": "101050001", "statement_descriptor": "INVOICE 2468", "transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n" }, "properties": { "account_number": { "description": "The account number for the destination account.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.", "type": "string", "x-documentation-priority": "default" }, "statement_descriptor": { "description": "A description set when the ACH Transfer was created.", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the ACH Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } }, "required": [ "amount", "account_number", "routing_number", "statement_descriptor", "transfer_id" ], "title": "Transaction Transaction Source ACH Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Intentions", "nullable": true }, "ach_transfer_rejection": { "additionalProperties": true, "description": "An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`. An ACH Transfer Rejection is created when an ACH Transfer is rejected by Increase. It offsets the ACH Transfer Intention. These rejections are rare.", "example": { "transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n" }, "properties": { "transfer_id": { "description": "The identifier of the ACH Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } }, "required": [ "transfer_id" ], "title": "Transaction Transaction Source ACH Transfer Rejection", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Rejections", "nullable": true }, "ach_transfer_return": { "additionalProperties": true, "description": "An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer Return is created when an ACH Transfer is returned by the receiving bank. It offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within the first two business days after the transfer is initiated, but can occur much later.", "example": { "created_at": "2020-01-31T23:59:59Z", "raw_return_reason_code": "R01", "return_reason_code": "insufficient_fund", "trace_number": "111122223292834", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "properties": { "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "raw_return_reason_code": { "description": "The three character ACH return code, in the range R01 to R85.", "type": "string", "x-documentation-priority": "default" }, "return_reason_code": { "description": "Why the ACH Transfer was returned. This reason code is sent by the receiving bank back to Increase.", "enum": [ "insufficient_fund", "no_account", "account_closed", "invalid_account_number_structure", "account_frozen_entry_returned_per_ofac_instruction", "credit_entry_refused_by_receiver", "unauthorized_debit_to_consumer_account_using_corporate_sec_code", "corporate_customer_advised_not_authorized", "payment_stopped", "non_transaction_account", "uncollected_funds", "routing_number_check_digit_error", "customer_advised_unauthorized_improper_ineligible_or_incomplete", "amount_field_error", "authorization_revoked_by_customer", "invalid_ach_routing_number", "file_record_edit_criteria", "enr_invalid_individual_name", "returned_per_odfi_request", "limited_participation_dfi", "incorrectly_coded_outbound_international_payment", "account_sold_to_another_dfi", "addenda_error", "beneficiary_or_account_holder_deceased", "customer_advised_not_within_authorization_terms", "corrected_return", "duplicate_entry", "duplicate_return", "enr_duplicate_enrollment", "enr_invalid_dfi_account_number", "enr_invalid_individual_id_number", "enr_invalid_representative_payee_indicator", "enr_invalid_transaction_code", "enr_return_of_enr_entry", "enr_routing_number_check_digit_error", "entry_not_processed_by_gateway", "field_error", "foreign_receiving_dfi_unable_to_settle", "iat_entry_coding_error", "improper_effective_entry_date", "improper_source_document_source_document_presented", "invalid_company_id", "invalid_foreign_receiving_dfi_identification", "invalid_individual_id_number", "item_and_rck_entry_presented_for_payment", "item_related_to_rck_entry_is_ineligible", "mandatory_field_error", "misrouted_dishonored_return", "misrouted_return", "no_errors_found", "non_acceptance_of_r62_dishonored_return", "non_participant_in_iat_program", "permissible_return_entry", "permissible_return_entry_not_accepted", "rdfi_non_settlement", "rdfi_participant_in_check_truncation_program", "representative_payee_deceased_or_unable_to_continue_in_that_capacity", "return_not_a_duplicate", "return_of_erroneous_or_reversing_debit", "return_of_improper_credit_entry", "return_of_improper_debit_entry", "return_of_xck_entry", "source_document_presented_for_payment", "state_law_affecting_rck_acceptance", "stop_payment_on_item_related_to_rck_entry", "stop_payment_on_source_document", "timely_original_return", "trace_number_error", "untimely_dishonored_return", "untimely_return" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to \"NSF.\"", "Code R03. The account does not exist or the receiving bank was unable to locate it.", "Code R02. The account is closed at the receiving bank.", "Code R04. The account number is invalid at the receiving bank.", "Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.", "Code R23. The receiving bank refused the credit transfer.", "Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.", "Code R29. The corporate customer at the receiving bank reversed the transfer.", "Code R08. The receiving bank stopped payment on this transfer.", "Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.", "Code R09. The receiving bank account does not have enough available balance for the transfer.", "Code R28. The routing number is incorrect.", "Code R10. The customer at the receiving bank reversed the transfer.", "Code R19. The amount field is incorrect or too large.", "Code R07. The customer revoked their authorization for a previously authorized transfer.", "Code R13. The routing number is invalid.", "Code R17. The receiving bank is unable to process a field in the transfer.", "Code R45. A rare return reason. The individual name field was invalid.", "Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.", "Code R34. The receiving bank's regulatory supervisor has limited their participation in the ACH network.", "Code R85. The outbound international ACH transfer was incorrect.", "Code R12. A rare return reason. The account was sold to another bank.", "Code R25. The addenda record is incorrect or missing.", "Code R15. A rare return reason. The account holder is deceased.", "Code R11. A rare return reason. The customer authorized some payment to the sender, but this payment was not in error.", "Code R74. A rare return reason. Sent in response to a return that was returned with code `field_error`. The latest return should include the corrected field(s).", "Code R24. A rare return reason. The receiving bank received an exact duplicate entry with the same trace number and amount.", "Code R67. A rare return reason. The return this message refers to was a duplicate.", "Code R47. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R43. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R44. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R46. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R41. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R40. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R42. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages.", "Code R84. A rare return reason. The International ACH Transfer cannot be processed by the gateway.", "Code R69. A rare return reason. One or more of the fields in the ACH were malformed.", "Code R83. A rare return reason. The Foreign receiving bank was unable to settle this ACH transfer.", "Code R80. A rare return reason. The International ACH Transfer is malformed.", "Code R18. A rare return reason. The ACH has an improper effective entry date field.", "Code R39. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R21. A rare return reason. The Company ID field of the ACH was invalid.", "Code R82. A rare return reason. The foreign receiving bank identifier for an International ACH Transfer was invalid.", "Code R22. A rare return reason. The Individual ID number field of the ACH was invalid.", "Code R53. A rare return reason. Both the Represented Check (\"RCK\") entry and the original check were presented to the bank.", "Code R51. A rare return reason. The Represented Check (\"RCK\") entry is ineligible.", "Code R26. A rare return reason. The ACH is missing a required field.", "Code R71. A rare return reason. The receiving bank does not recognize the routing number in a dishonored return entry.", "Code R61. A rare return reason. The receiving bank does not recognize the routing number in a return entry.", "Code R76. A rare return reason. Sent in response to a return, the bank does not find the errors alleged by the returning bank.", "Code R77. A rare return reason. The receiving bank does not accept the return of the erroneous debit. The funds are not available at the receiving bank.", "Code R81. A rare return reason. The receiving bank does not accept International ACH Transfers.", "Code R31. A rare return reason. A return that has been agreed to be accepted by the receiving bank, despite falling outside of the usual return timeframe.", "Code R70. A rare return reason. The receiving bank had not approved this return.", "Code R32. A rare return reason. The receiving bank could not settle this transaction.", "Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers.", "Code R14. A rare return reason. The payee is deceased.", "Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate.", "Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it.", "Code R36. A rare return reason. Return of a malformed credit entry.", "Code R35. A rare return reason. Return of a malformed debit entry.", "Code R33. A rare return reason. Return of a destroyed check (\"XCK\") entry.", "Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.", "Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check (\"RCK\") entry.", "Code R52. A rare return reason. A stop payment was issued on a Represented Check (\"RCK\") entry.", "Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment.", "Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time.", "Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH.", "Code R72. A rare return reason. The dishonored return was sent too late.", "Code R68. A rare return reason. The return was sent too late." ] }, "trace_number": { "description": "A 15 digit number that was generated by the bank that initiated the return. The trace number of the return is different than that of the original transfer. ACH trace numbers are not unique, but along with the amount and date this number can be used to identify the ACH return at the bank that initiated it.", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the Transaction associated with this return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "transfer_id": { "description": "The identifier of the ACH Transfer associated with this return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } }, "required": [ "created_at", "trace_number", "return_reason_code", "raw_return_reason_code", "transfer_id", "transaction_id" ], "title": "Transaction Transaction Source ACH Transfer Return", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ACH Transfer Returns", "nullable": true }, "blockchain_offramp_transfer_settlement": { "additionalProperties": true, "description": "A Blockchain Off-Ramp Transfer Settlement object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_offramp_transfer_settlement`.", "example": { "source_blockchain_address_id": "blockchain_address_tijjpqp9t5d358ehydqi", "transfer_id": "blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m" }, "properties": { "source_blockchain_address_id": { "description": "The identifier of the Blockchain Address the funds were received at.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Blockchain Addresses" }, "transfer_id": { "description": "The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Blockchain Off-Ramp Transfers" } }, "required": [ "transfer_id", "source_blockchain_address_id" ], "title": "Transaction Transaction Source Blockchain Off-Ramp Transfer Settlement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Blockchain Off-Ramp Transfer Settlements", "nullable": true }, "blockchain_onramp_transfer_intention": { "additionalProperties": true, "description": "A Blockchain On-Ramp Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_onramp_transfer_intention`.", "example": { "destination_blockchain_address": "0xaabbccdd", "transfer_id": "blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv" }, "properties": { "destination_blockchain_address": { "description": "The blockchain address the funds were sent to.", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Blockchain On-Ramp Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Blockchain On-Ramp Transfers" } }, "required": [ "transfer_id", "destination_blockchain_address" ], "title": "Transaction Transaction Source Blockchain On-Ramp Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Blockchain On-Ramp Transfer Intentions", "nullable": true }, "card_dispute_acceptance": { "additionalProperties": true, "description": "A Legacy Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`. Contains the details of a successful Card Dispute.", "example": { "accepted_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "accepted_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the Transaction that was created to return the disputed funds to your account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "accepted_at", "transaction_id" ], "title": "Transaction Transaction Source Legacy Card Dispute Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Legacy Card Dispute Acceptances", "nullable": true }, "card_dispute_financial": { "additionalProperties": true, "description": "A Card Dispute Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_financial`. Financial event related to a Card Dispute.", "example": { "amount": 1000, "network": "visa", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "visa": { "event_type": "chargeback_submitted" } }, "properties": { "amount": { "description": "The amount of the financial event.", "type": "integer", "x-documentation-priority": "default" }, "network": { "description": "The network that the Card Dispute is associated with.", "enum": [ "visa", "pulse" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Visa: details will be under the `visa` object.", "Pulse: details will be under the `pulse` object." ] }, "transaction_id": { "description": "The identifier of the Transaction that was created to credit or debit the disputed funds to or from your account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Dispute Financials" }, "visa": { "description": "Information for events related to card dispute for card payments processed over Visa's network. This field will be present in the JSON response if and only if `network` is equal to `visa`.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_dispute_financial_visa" } ], "nullable": true } }, "required": [ "amount", "network", "transaction_id", "visa" ], "title": "Transaction Transaction Source Card Dispute Financial", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Dispute Financials", "nullable": true }, "card_dispute_loss": { "additionalProperties": true, "description": "A Legacy Card Dispute Loss object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_loss`. Contains the details of a lost Card Dispute.", "example": { "explanation": "The card dispute was lost.", "lost_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "explanation": { "description": "Why the Card Dispute was lost.", "type": "string", "x-documentation-priority": "default" }, "lost_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was lost.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the Transaction that was created to debit the disputed funds from your account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "lost_at", "transaction_id", "explanation" ], "title": "Transaction Transaction Source Legacy Card Dispute Loss", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Legacy Card Dispute Losses", "nullable": true }, "card_financial": { "description": "A Card Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_financial`. Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_financial" } ], "nullable": true }, "card_push_transfer_acceptance": { "additionalProperties": true, "description": "A Card Push Transfer Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_push_transfer_acceptance`. A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer sent from Increase is accepted by the receiving bank.", "example": { "settlement_amount": 100, "transfer_id": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye" }, "properties": { "settlement_amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Card Push Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Push Transfers" } }, "required": [ "settlement_amount", "transfer_id" ], "title": "Transaction Transaction Source Card Push Transfer Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Push Transfer Acceptances", "nullable": true }, "card_refund": { "description": "A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`. Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_refund" } ], "nullable": true }, "card_revenue_payment": { "additionalProperties": true, "description": "A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`. Card Revenue Payments reflect earnings from fees on card transactions.", "example": { "amount": 100, "currency": "USD", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00", "transacted_on_account_id": "account_in71c4amph0vgo2qllky" }, "properties": { "amount": { "description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "period_end": { "description": "The end of the period for which this transaction paid interest.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "period_start": { "description": "The start of the period for which this transaction paid interest.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transacted_on_account_id": { "description": "The account the card belonged to.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts", "nullable": true } }, "required": [ "amount", "currency", "period_start", "period_end", "transacted_on_account_id" ], "title": "Transaction Transaction Source Card Revenue Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Card Revenue Payments", "nullable": true }, "card_settlement": { "description": "A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`. Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/card_settlement" } ], "nullable": true }, "cashback_payment": { "additionalProperties": true, "description": "A Cashback Payment object. This field will be present in the JSON response if and only if `category` is equal to `cashback_payment`. A Cashback Payment represents the cashback paid to a cardholder for a given period. Cashback is usually paid monthly for the prior month's transactions.", "example": { "accrued_on_card_id": "card_oubs0hwk5rn6knuecxg2", "amount": 100, "currency": "USD", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00" }, "properties": { "accrued_on_card_id": { "description": "The card on which the cashback was accrued.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards", "nullable": true }, "amount": { "description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "period_end": { "description": "The end of the period for which this transaction paid cashback.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "period_start": { "description": "The start of the period for which this transaction paid cashback.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency", "period_start", "period_end", "accrued_on_card_id" ], "title": "Transaction Transaction Source Cashback Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Cashback Payments", "nullable": true }, "category": { "description": "The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.", "enum": [ "account_transfer_intention", "ach_transfer_intention", "ach_transfer_rejection", "ach_transfer_return", "cashback_payment", "card_dispute_acceptance", "card_dispute_financial", "card_dispute_loss", "card_refund", "card_settlement", "card_financial", "card_revenue_payment", "check_deposit_acceptance", "check_deposit_return", "fednow_transfer_acknowledgement", "check_transfer_deposit", "fee_payment", "inbound_ach_transfer", "inbound_ach_transfer_return_intention", "inbound_check_deposit_return_intention", "inbound_check_adjustment", "inbound_fednow_transfer_confirmation", "inbound_real_time_payments_transfer_confirmation", "inbound_wire_reversal", "inbound_wire_transfer", "inbound_wire_transfer_reversal", "interest_payment", "internal_source", "real_time_payments_transfer_acknowledgement", "sample_funds", "wire_transfer_intention", "swift_transfer_intention", "swift_transfer_return", "card_push_transfer_acceptance", "account_revenue_payment", "blockchain_onramp_transfer_intention", "blockchain_offramp_transfer_settlement", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account Transfer Intention: details will be under the `account_transfer_intention` object.", "ACH Transfer Intention: details will be under the `ach_transfer_intention` object.", "ACH Transfer Rejection: details will be under the `ach_transfer_rejection` object.", "ACH Transfer Return: details will be under the `ach_transfer_return` object.", "Cashback Payment: details will be under the `cashback_payment` object.", "Legacy Card Dispute Acceptance: details will be under the `card_dispute_acceptance` object.", "Card Dispute Financial: details will be under the `card_dispute_financial` object.", "Legacy Card Dispute Loss: details will be under the `card_dispute_loss` object.", "Card Refund: details will be under the `card_refund` object.", "Card Settlement: details will be under the `card_settlement` object.", "Card Financial: details will be under the `card_financial` object.", "Card Revenue Payment: details will be under the `card_revenue_payment` object.", "Check Deposit Acceptance: details will be under the `check_deposit_acceptance` object.", "Check Deposit Return: details will be under the `check_deposit_return` object.", "FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.", "Check Transfer Deposit: details will be under the `check_transfer_deposit` object.", "Fee Payment: details will be under the `fee_payment` object.", "Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` object.", "Inbound ACH Transfer Return Intention: details will be under the `inbound_ach_transfer_return_intention` object.", "Inbound Check Deposit Return Intention: details will be under the `inbound_check_deposit_return_intention` object.", "Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.", "Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.", "Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.", "Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object.", "Inbound Wire Transfer Intention: details will be under the `inbound_wire_transfer` object.", "Inbound Wire Transfer Reversal Intention: details will be under the `inbound_wire_transfer_reversal` object.", "Interest Payment: details will be under the `interest_payment` object.", "Internal Source: details will be under the `internal_source` object.", "Real-Time Payments Transfer Acknowledgement: details will be under the `real_time_payments_transfer_acknowledgement` object.", "Sample Funds: details will be under the `sample_funds` object.", "Wire Transfer Intention: details will be under the `wire_transfer_intention` object.", "Swift Transfer Intention: details will be under the `swift_transfer_intention` object.", "Swift Transfer Return: details will be under the `swift_transfer_return` object.", "Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.", "Account Revenue Payment: details will be under the `account_revenue_payment` object.", "Blockchain On-Ramp Transfer Intention: details will be under the `blockchain_onramp_transfer_intention` object.", "Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.", "The Transaction was made for an undocumented or deprecated reason." ] }, "check_deposit_acceptance": { "additionalProperties": true, "description": "A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`. A Check Deposit Acceptance is created when a Check Deposit is processed and its details confirmed. Check Deposits may be returned by the receiving bank, which will appear as a Check Deposit Return.", "example": { "account_number": "987654321", "amount": 1000, "auxiliary_on_us": "101", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "routing_number": "101050001", "serial_number": null }, "properties": { "account_number": { "description": "The account number printed on the check. This is an account at the bank that issued the check.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "auxiliary_on_us": { "description": "An additional line of metadata printed on the check. This typically includes the check number for business checks.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "check_deposit_id": { "description": "The ID of the Check Deposit that was accepted.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "routing_number": { "description": "The routing number printed on the check. This is a routing number for the bank that issued the check.", "type": "string", "x-documentation-priority": "default" }, "serial_number": { "description": "The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "amount", "currency", "account_number", "routing_number", "auxiliary_on_us", "serial_number", "check_deposit_id" ], "title": "Transaction Transaction Source Check Deposit Acceptance", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Acceptances", "nullable": true }, "check_deposit_return": { "additionalProperties": true, "description": "A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`. A Check Deposit Return is created when a Check Deposit is returned by the bank holding the account it was drawn against. Check Deposits may be returned for a variety of reasons, including insufficient funds or a mismatched account number. Usually, checks are returned within the first 7 days after the deposit is made.", "example": { "amount": 100, "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "return_reason": "insufficient_funds", "returned_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "properties": { "amount": { "description": "The returned amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "check_deposit_id": { "description": "The identifier of the Check Deposit that was returned.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "return_reason": { "description": "Why this check was returned by the bank holding the account it was drawn against.", "enum": [ "ach_conversion_not_supported", "closed_account", "duplicate_submission", "insufficient_funds", "no_account", "not_authorized", "stale_dated", "stop_payment", "unknown_reason", "unmatched_details", "unreadable_image", "endorsement_irregular", "altered_or_fictitious_item", "frozen_or_blocked_account", "post_dated", "endorsement_missing", "signature_missing", "stop_payment_suspect", "unusable_image", "image_fails_security_check", "cannot_determine_amount", "signature_irregular", "non_cash_item", "unable_to_process", "item_exceeds_dollar_limit", "branch_or_account_sold" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The check doesn't allow ACH conversion.", "The account is closed. (Check21 return code `D`)", "The check has already been deposited. (Check21 return code `Y`)", "Insufficient funds (Check21 return code `A`)", "No account was found matching the check details. (Check21 return code `E`)", "The check was not authorized. (Check21 return code `Q`)", "The check is too old. (Check21 return code `G`)", "The payment has been stopped by the account holder. (Check21 return code `C`)", "The reason for the return is unknown.", "The image doesn't match the details submitted.", "The image could not be read. (Check21 return code `U`)", "The check endorsement was irregular. (Check21 return code `J`)", "The check present was either altered or fake. (Check21 return code `N`)", "The account this check is drawn on is frozen. (Check21 return code `F`)", "The check is post dated. (Check21 return code `H`)", "The endorsement was missing. (Check21 return code `I`)", "The check signature was missing. (Check21 return code `K`)", "The bank suspects a stop payment will be placed. (Check21 return code `T`)", "The bank cannot read the image. (Check21 return code `U`)", "The check image fails the bank's security check. (Check21 return code `V`)", "The bank cannot determine the amount. (Check21 return code `W`)", "The signature is inconsistent with prior signatures. (Check21 return code `L`)", "The check is a non-cash item and cannot be drawn against the account. (Check21 return code `M`)", "The bank is unable to process this check. (Check21 return code `O`)", "The check exceeds the bank or customer's limit. (Check21 return code `P`)", "The bank sold this account and no longer services this customer. (Check21 return code `R`)" ] }, "returned_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "transaction_id": { "description": "The identifier of the transaction that reversed the original check deposit transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } }, "required": [ "amount", "returned_at", "currency", "check_deposit_id", "transaction_id", "return_reason" ], "title": "Transaction Transaction Source Check Deposit Return", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Check Deposit Returns", "nullable": true }, "check_transfer_deposit": { "description": "A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/check_transfer_deposit" } ], "nullable": true }, "fednow_transfer_acknowledgement": { "additionalProperties": true, "description": "A FedNow Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.", "example": { "transfer_id": "fednow_transfer_4i0mptrdu1mueg1196bg" }, "properties": { "transfer_id": { "description": "The identifier of the FedNow Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "FedNow Transfers" } }, "required": [ "transfer_id" ], "title": "Transaction Transaction Source FedNow Transfer Acknowledgement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "FedNow Transfer Acknowledgements", "nullable": true }, "fee_payment": { "additionalProperties": true, "description": "A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`. A Fee Payment represents a payment made to Increase.", "example": { "amount": 100, "currency": "USD", "fee_period_start": "2023-05-01", "fee_statement_id": "fee_statement_lz33v0d7pnxwkptrdwq4", "program_id": "program_i2v2os4mwza1oetokh9i" }, "properties": { "amount": { "description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "fee_period_start": { "description": "The start of this payment's fee period, usually the first day of a month.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "program_id": { "description": "The Program for which this fee was incurred.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs", "nullable": true } }, "required": [ "amount", "currency", "fee_period_start", "program_id" ], "title": "Transaction Transaction Source Fee Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Fee Payments", "nullable": true }, "inbound_ach_transfer": { "additionalProperties": true, "description": "An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`. An Inbound ACH Transfer Intention is created when an ACH transfer is initiated at another bank and received by Increase.", "example": { "addenda": null, "amount": 100, "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" }, "properties": { "addenda": { "additionalProperties": false, "description": "Additional information sent from the originator.", "properties": { "category": { "description": "The type of addendum.", "enum": [ "freeform" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Unstructured addendum." ] }, "freeform": { "additionalProperties": false, "description": "Unstructured `payment_related_information` passed through by the originator.", "properties": { "entries": { "description": "Each entry represents an addendum received from the originator.", "items": { "additionalProperties": false, "properties": { "payment_related_information": { "description": "The payment related information passed in the addendum.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "payment_related_information" ], "title": "Transaction Transaction Source Inbound ACH Transfer Intention Addenda Freeform EntriesElement", "type": "object", "x-event-categories": [], "x-title-plural": "EntriesElements" }, "type": "array", "x-documentation-priority": "default" } }, "required": [ "entries" ], "title": "Transaction Transaction Source Inbound ACH Transfer Intention Addenda Freeform", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Freeforms", "nullable": true } }, "required": [ "category", "freeform" ], "title": "Transaction Transaction Source Inbound ACH Transfer Intention Addenda", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addendas", "nullable": true }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "originator_company_descriptive_date": { "description": "The description of the date of the transfer, usually in the format `YYMMDD`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_company_discretionary_data": { "description": "Data set by the originator.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "originator_company_entry_description": { "description": "An informational description of the transfer.", "type": "string", "x-documentation-priority": "default" }, "originator_company_id": { "description": "An identifier for the originating company. This is generally, but not always, a stable identifier across multiple transfers.", "type": "string", "x-documentation-priority": "default" }, "originator_company_name": { "description": "A name set by the originator to identify themselves.", "type": "string", "x-documentation-priority": "default" }, "receiver_id_number": { "description": "The originator's identifier for the transfer recipient.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "receiver_name": { "description": "The name of the transfer recipient. This value is informational and not verified by Increase.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "trace_number": { "description": "A 15 digit number recorded in the Nacha file and available to both the originating and receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at either bank. ACH trace numbers are not unique, but are [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The Inbound ACH Transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" } }, "required": [ "amount", "originator_company_name", "originator_company_descriptive_date", "originator_company_discretionary_data", "originator_company_entry_description", "originator_company_id", "receiver_id_number", "receiver_name", "trace_number", "transfer_id", "addenda" ], "title": "Transaction Transaction Source Inbound ACH Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound ACH Transfer Intentions", "nullable": true }, "inbound_ach_transfer_return_intention": { "description": "An Inbound ACH Transfer Return Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_ach_transfer_return_intention" } ], "nullable": true }, "inbound_check_adjustment": { "description": "An Inbound Check Adjustment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check_adjustment`. An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_check_adjustment" } ], "nullable": true }, "inbound_check_deposit_return_intention": { "description": "An Inbound Check Deposit Return Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_check_deposit_return_intention" } ], "nullable": true }, "inbound_fednow_transfer_confirmation": { "additionalProperties": true, "description": "An Inbound FedNow Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation is created when a FedNow transfer is initiated at another bank and received by Increase.", "example": { "transfer_id": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20" }, "properties": { "transfer_id": { "description": "The identifier of the FedNow Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound FedNow Transfers" } }, "required": [ "transfer_id" ], "title": "Transaction Transaction Source Inbound FedNow Transfer Confirmation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound FedNow Transfer Confirmations", "nullable": true }, "inbound_real_time_payments_transfer_confirmation": { "additionalProperties": true, "description": "An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time Payments Transfer Confirmation is created when a Real-Time Payments transfer is initiated at another bank and received by Increase.", "example": { "amount": 100, "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "transaction_identification": "20220501234567891T1BSLZO01745013025", "transfer_id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "amount": { "description": "The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "creditor_name": { "description": "The name the sender of the transfer specified as the recipient of the transfer.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be \"USD\" for a Real-Time Payments transfer.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor_account_number": { "description": "The account number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_name": { "description": "The name provided by the sender of the transfer.", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The routing number of the account that sent the transfer.", "type": "string", "x-documentation-priority": "default" }, "transaction_identification": { "description": "The Real-Time Payments network identification of the transfer.", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Real-Time Payments Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Real-Time Payments Transfers" }, "unstructured_remittance_information": { "description": "Additional information included with the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "amount", "currency", "creditor_name", "debtor_name", "debtor_account_number", "debtor_routing_number", "transaction_identification", "unstructured_remittance_information", "transfer_id" ], "title": "Transaction Transaction Source Inbound Real-Time Payments Transfer Confirmation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound Real-Time Payments Transfer Confirmations", "nullable": true }, "inbound_wire_reversal": { "additionalProperties": true, "description": "An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire Reversal represents a reversal of a wire transfer that was initiated via Increase. The other bank is sending the money back. This most often happens when the original destination account details were incorrect.", "example": { "amount": 12345, "created_at": "2020-01-31T23:59:59Z", "debtor_routing_number": "101050001", "description": "Inbound wire reversal 2022021100335128", "input_cycle_date": "2022-02-11", "input_message_accountability_data": "20220211B6B7HU2R011023", "input_sequence_number": "11023", "input_source": "B6B7HU2R", "instruction_identification": null, "return_reason_additional_information": null, "return_reason_code": null, "return_reason_code_description": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "wire_transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u" }, "properties": { "amount": { "description": "The amount that was reversed in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The debtor's routing number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "description": { "description": "The description on the reversal message from Fedwire, set by the reversing bank.", "type": "string", "x-documentation-priority": "default" }, "input_cycle_date": { "description": "The Fedwire cycle date for the wire reversal. The \"Fedwire day\" begins at 9:00 PM Eastern Time on the evening before the `cycle date`.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "input_message_accountability_data": { "description": "The Fedwire transaction identifier.", "type": "string", "x-documentation-priority": "default" }, "input_sequence_number": { "description": "The Fedwire sequence number.", "type": "string", "x-documentation-priority": "default" }, "input_source": { "description": "The Fedwire input source identifier.", "type": "string", "x-documentation-priority": "default" }, "instruction_identification": { "description": "The sending bank's identifier for the reversal.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason_additional_information": { "description": "Additional information about the reason for the reversal.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason_code": { "description": "A code provided by the sending bank giving a reason for the reversal. The common return reason codes are [documented here](/documentation/wire-reversals#reversal-reason-codes).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason_code_description": { "description": "An Increase-generated description of the `return_reason_code`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "The ID for the Transaction associated with the transfer reversal.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "wire_transfer_id": { "description": "The ID for the Wire Transfer that is being reversed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } }, "required": [ "amount", "created_at", "description", "input_cycle_date", "input_sequence_number", "input_source", "input_message_accountability_data", "transaction_id", "wire_transfer_id", "instruction_identification", "debtor_routing_number", "return_reason_code", "return_reason_code_description", "return_reason_additional_information" ], "title": "Transaction Transaction Source Inbound Wire Reversal", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound Wire Reversals", "nullable": true }, "inbound_wire_transfer": { "additionalProperties": true, "description": "An Inbound Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`. An Inbound Wire Transfer Intention is created when a wire transfer is initiated at another bank and received by Increase.", "example": { "amount": 100, "creditor_address_line1": null, "creditor_address_line2": null, "creditor_address_line3": null, "creditor_name": null, "debtor_address_line1": null, "debtor_address_line2": null, "debtor_address_line3": null, "debtor_name": null, "description": "Inbound wire transfer", "end_to_end_identification": null, "input_message_accountability_data": null, "instructing_agent_routing_number": null, "instruction_identification": null, "transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "unique_end_to_end_transaction_reference": null, "unstructured_remittance_information": null }, "properties": { "amount": { "description": "The amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "creditor_address_line1": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_address_line2": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_address_line3": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "creditor_name": { "description": "A name set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line1": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line2": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_address_line3": { "description": "A free-form address field set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "debtor_name": { "description": "A name set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "description": { "description": "An Increase-constructed description of the transfer.", "type": "string", "x-documentation-priority": "default" }, "end_to_end_identification": { "description": "A free-form reference string set by the sender, to help identify the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "input_message_accountability_data": { "description": "A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "instructing_agent_routing_number": { "description": "The American Banking Association (ABA) routing number of the bank that sent the wire.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "instruction_identification": { "description": "The sending bank's identifier for the wire transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transfer_id": { "description": "The ID of the Inbound Wire Transfer object that resulted in this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers" }, "unique_end_to_end_transaction_reference": { "description": "The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "unstructured_remittance_information": { "description": "A free-form message set by the sender.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "amount", "description", "input_message_accountability_data", "transfer_id", "creditor_address_line1", "creditor_address_line2", "creditor_address_line3", "creditor_name", "end_to_end_identification", "debtor_address_line1", "debtor_address_line2", "debtor_address_line3", "debtor_name", "instructing_agent_routing_number", "unstructured_remittance_information", "instruction_identification", "unique_end_to_end_transaction_reference" ], "title": "Transaction Transaction Source Inbound Wire Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound Wire Transfer Intentions", "nullable": true }, "inbound_wire_transfer_reversal": { "description": "An Inbound Wire Transfer Reversal Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed.", "x-documentation-priority": "default", "allOf": [ { "$ref": "#/components/schemas/inbound_wire_transfer_reversal" } ], "nullable": true }, "interest_payment": { "additionalProperties": true, "description": "An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`. An Interest Payment represents a payment of interest on an account. Interest is usually paid monthly.", "example": { "accrued_on_account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "currency": "USD", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00" }, "properties": { "accrued_on_account_id": { "description": "The account on which the interest was accrued.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "amount": { "description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "period_end": { "description": "The end of the period for which this transaction paid interest.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "period_start": { "description": "The start of the period for which this transaction paid interest.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "currency", "period_start", "period_end", "accrued_on_account_id" ], "title": "Transaction Transaction Source Interest Payment", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Interest Payments", "nullable": true }, "internal_source": { "additionalProperties": true, "description": "An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`. A transaction between the user and Increase. See the `reason` attribute for more information.", "example": { "amount": 100, "currency": "USD", "reason": "sample_funds" }, "properties": { "amount": { "description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.", "type": "integer", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "reason": { "description": "An Internal Source is a transaction between you and Increase. This describes the reason for the transaction.", "enum": [ "account_closure", "account_revenue_payment_distribution", "bank_drawn_check", "bank_drawn_check_credit", "bank_migration", "check_adjustment", "collection_payment", "collection_receivable", "dishonored_ach_return", "empyreal_adjustment", "error", "error_correction", "fees", "general_ledger_transfer", "interest", "negative_balance_forgiveness", "sample_funds", "sample_funds_return" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Account closure", "Account revenue payment distribution", "Bank-drawn check", "Bank-drawn check credit", "Bank migration", "Check adjustment", "Collection payment", "Collection receivable", "Dishonored ACH return", "Empyreal adjustment", "Error", "Error correction", "Fees", "General ledger transfer", "Interest", "Negative balance forgiveness", "Sample funds", "Sample funds return" ] } }, "required": [ "amount", "currency", "reason" ], "title": "Transaction Transaction Source Internal Source", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Internal Sources", "nullable": true }, "other": { "additionalProperties": false, "description": "If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null.", "properties": {}, "title": "Transaction Transaction Source Other", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Others", "nullable": true }, "real_time_payments_transfer_acknowledgement": { "additionalProperties": true, "description": "A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer Acknowledgement is created when a Real-Time Payments Transfer sent from Increase is acknowledged by the receiving bank.", "example": { "account_number": "987654321", "amount": 100, "routing_number": "101050001", "transfer_id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Real-Time Payments Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" }, "unstructured_remittance_information": { "description": "Unstructured information that will show on the recipient's bank statement.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "amount", "account_number", "routing_number", "unstructured_remittance_information", "transfer_id" ], "title": "Transaction Transaction Source Real-Time Payments Transfer Acknowledgement", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Real-Time Payments Transfer Acknowledgements", "nullable": true }, "sample_funds": { "additionalProperties": true, "description": "A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`. Sample funds for testing purposes.", "example": { "originator": "dashboard" }, "properties": { "originator": { "description": "Where the sample funds came from.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "originator" ], "title": "Transaction Transaction Source Sample Funds", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Sample Funds", "nullable": true }, "swift_transfer_intention": { "additionalProperties": true, "description": "A Swift Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_intention`. A Swift Transfer initiated via Increase.", "example": { "transfer_id": "swift_transfer_29h21xkng03788zwd3fh" }, "properties": { "transfer_id": { "description": "The identifier of the Swift Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" } }, "required": [ "transfer_id" ], "title": "Transaction Transaction Source Swift Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Swift Transfer Intentions", "nullable": true }, "swift_transfer_return": { "additionalProperties": true, "description": "A Swift Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer Return is created when a Swift Transfer is returned by the receiving bank.", "example": { "transfer_id": "swift_transfer_29h21xkng03788zwd3fh" }, "properties": { "transfer_id": { "description": "The identifier of the Swift Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" } }, "required": [ "transfer_id" ], "title": "Transaction Transaction Source Swift Transfer Return", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Swift Transfer Returns", "nullable": true }, "wire_transfer_intention": { "additionalProperties": true, "description": "A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`. A Wire Transfer initiated via Increase and sent to a different bank.", "example": { "account_number": "987654321", "amount": 100, "message_to_recipient": "HELLO", "routing_number": "101050001", "transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u" }, "properties": { "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "message_to_recipient": { "description": "The message that will show on the recipient's bank statement.", "type": "string", "x-documentation-priority": "default" }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "transfer_id": { "description": "The identifier of the Wire Transfer that led to this Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } }, "required": [ "amount", "account_number", "routing_number", "message_to_recipient", "transfer_id" ], "title": "Transaction Transaction Source Wire Transfer Intention", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Wire Transfer Intentions", "nullable": true } }, "required": [ "category" ], "title": "Transaction Transaction Source", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transaction Sources" }, "type": { "description": "A constant representing the object's type. For this resource it will always be `transaction`.", "enum": [ "transaction" ], "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "account_id", "amount", "currency", "created_at", "description", "id", "route_id", "route_type", "source" ], "title": "Transaction", "type": "object", "x-event-categories": [ "transaction.created" ], "x-tag": "Transactions", "x-title-plural": "Transactions" }, "transaction_list": { "additionalProperties": true, "description": "A list of Transaction objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "inbound_ach_transfer", "inbound_ach_transfer": { "addenda": null, "amount": 100, "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" } }, "type": "transaction" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/transaction" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Transaction List", "type": "object", "x-event-categories": [], "x-title-plural": "Transaction Lists" }, "update_a_beneficial_owner_parameters": { "additionalProperties": false, "example": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": "Unit 2", "state": "NY", "zip": "10045" } }, "properties": { "address": { "additionalProperties": false, "description": "The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The individual's legal name.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "update_a_card_parameters": { "additionalProperties": false, "example": { "description": "New description" }, "properties": { "authorization_controls": { "additionalProperties": false, "description": "Controls that restrict how this card can be used.", "properties": { "merchant_acceptor_identifier": { "additionalProperties": false, "description": "Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The Merchant Acceptor IDs that are allowed for authorizations on this card. Authorizations with Merchant Acceptor IDs not in this list will be declined.", "items": { "additionalProperties": false, "properties": { "identifier": { "description": "The Merchant Acceptor ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "identifier" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "blocked": { "description": "The Merchant Acceptor IDs that are blocked for authorizations on this card. Authorizations with Merchant Acceptor IDs in this list will be declined.", "items": { "additionalProperties": false, "properties": { "identifier": { "description": "The Merchant Acceptor ID.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "identifier" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_category_code": { "additionalProperties": false, "description": "Restricts which Merchant Category Codes are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The Merchant Category Codes that are allowed for authorizations on this card. Authorizations with Merchant Category Codes not in this list will be declined.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "blocked": { "description": "The Merchant Category Codes that are blocked for authorizations on this card. Authorizations with Merchant Category Codes in this list will be declined.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "merchant_country": { "additionalProperties": false, "description": "Restricts which merchant countries are allowed or blocked for authorizations on this card.", "properties": { "allowed": { "description": "The merchant countries that are allowed for authorizations on this card. Authorizations with merchant countries not in this list will be declined.", "items": { "additionalProperties": false, "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "type": "string", "x-documentation-priority": "default" } }, "required": [ "country" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "blocked": { "description": "The merchant countries that are blocked for authorizations on this card. Authorizations with merchant countries in this list will be declined.", "items": { "additionalProperties": false, "properties": { "country": { "description": "The ISO 3166-1 alpha-2 country code.", "maxLength": 2, "minLength": 2, "type": "string", "x-documentation-priority": "default" } }, "required": [ "country" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "usage": { "additionalProperties": false, "description": "Controls how many times this card can be used.", "properties": { "category": { "description": "Whether the card is for a single use or multiple uses.", "enum": [ "single_use", "multi_use" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card can only be used for a single authorization.", "The card can be used for multiple authorizations." ] }, "multi_use": { "additionalProperties": false, "description": "Controls for multi-use cards. Required if and only if `category` is `multi_use`.", "properties": { "spending_limits": { "description": "Spending limits for this card. The most restrictive limit applies if multiple limits match.", "items": { "additionalProperties": false, "properties": { "interval": { "description": "The interval at which the spending limit is enforced.", "enum": [ "all_time", "per_transaction", "per_day", "per_week", "per_month" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The spending limit applies over the lifetime of the card.", "The spending limit applies per transaction.", "The spending limit applies per day. Resets nightly at midnight UTC.", "The spending limit applies per week. Resets weekly on Mondays at midnight UTC.", "The spending limit applies per month. Resets on the first of the month, midnight UTC." ] }, "merchant_category_codes": { "description": "The Merchant Category Codes this spending limit applies to. If not set, the limit applies to all transactions.", "items": { "additionalProperties": false, "properties": { "code": { "description": "The Merchant Category Code.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "code" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "settlement_amount": { "description": "The maximum settlement amount permitted in the given interval.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "interval", "settlement_amount" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "single_use": { "additionalProperties": false, "description": "Controls for single-use cards. Required if and only if `category` is `single_use`.", "properties": { "settlement_amount": { "additionalProperties": false, "description": "The settlement amount constraint for this single-use card.", "properties": { "comparison": { "description": "The operator used to compare the settlement amount.", "enum": [ "equals", "less_than_or_equals" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The settlement amount must be exactly the specified value.", "The settlement amount must be less than or equal to the specified value." ] }, "value": { "description": "The settlement amount value.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "value", "comparison" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "settlement_amount" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "category" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "billing_address": { "additionalProperties": false, "description": "The card's updated billing address.", "properties": { "city": { "description": "The city of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "postal_code": { "description": "The postal code of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The US state of the billing address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "postal_code" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "description": { "description": "The description you choose to give the card.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "digital_wallet": { "additionalProperties": false, "description": "The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.", "properties": { "digital_card_profile_id": { "description": "The digital card profile assigned to this digital card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles" }, "email": { "description": "An email address that can be used to verify the cardholder via one-time passcode over email.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "phone": { "description": "A phone number that can be used to verify the cardholder via one-time passcode over SMS.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "entity_id": { "description": "The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" }, "status": { "description": "The status to update the Card with.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The card is active.", "The card is temporarily disabled.", "The card is permanently canceled." ] } }, "type": "object", "x-event-categories": [] }, "update_a_cards_pin_parameters": { "additionalProperties": false, "example": { "pin": "1234" }, "properties": { "pin": { "description": "The 4-digit PIN for the card, for use with ATMs.", "maxLength": 4, "minLength": 4, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, "required": [ "pin" ], "type": "object", "x-event-categories": [] }, "update_a_lockbox_address_parameters": { "additionalProperties": false, "example": { "status": "disabled" }, "properties": { "description": { "description": "The description you choose for the Lockbox Address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The status of the Lockbox Address.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This Lockbox Address is active.", "This Lockbox Address is disabled.", "This Lockbox Address is permanently disabled." ] } }, "type": "object", "x-event-categories": [] }, "update_a_lockbox_recipient_parameters": { "additionalProperties": false, "example": { "status": "active" }, "properties": { "description": { "description": "The description you choose for the Lockbox Recipient.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "recipient_name": { "description": "The name of the Lockbox Recipient.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "status": { "description": "The status of the Lockbox Recipient.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "This Lockbox Recipient is active.", "This Lockbox Recipient is disabled. Checks mailed to this Lockbox Recipient will be rejected.", "This Lockbox Recipient is canceled and cannot be modified. Checks mailed to this Lockbox Recipient will be rejected." ] } }, "type": "object", "x-event-categories": [] }, "update_a_physical_card_parameters": { "additionalProperties": false, "example": { "status": "disabled" }, "properties": { "status": { "description": "The status to update the Physical Card to.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The physical card is active.", "The physical card is temporarily disabled.", "The physical card is permanently canceled." ] } }, "required": [ "status" ], "type": "object", "x-event-categories": [] }, "update_an_account_number_parameters": { "additionalProperties": false, "example": { "inbound_ach": { "debit_status": "blocked" }, "status": "disabled" }, "properties": { "inbound_ach": { "additionalProperties": false, "description": "Options related to how this Account Number handles inbound ACH transfers.", "properties": { "debit_status": { "description": "Whether ACH debits are allowed against this Account Number. Note that ACH debits will be declined if this is `allowed` but the Account Number is not active.", "enum": [ "allowed", "blocked" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "ACH Debits are allowed.", "ACH Debits are blocked." ] } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "inbound_checks": { "additionalProperties": false, "description": "Options related to how this Account Number should handle inbound check withdrawals.", "properties": { "status": { "description": "How Increase should process checks with this account number printed on them.", "enum": [ "allowed", "check_transfers_only" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Checks with this Account Number will be processed even if they are not associated with a Check Transfer.", "Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer." ] } }, "required": [ "status" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The name you choose for the Account Number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "status": { "description": "This indicates if transfers can be made to the Account Number.", "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The account number is active.", "The account number is temporarily disabled.", "The account number is permanently disabled." ] } }, "type": "object", "x-event-categories": [] }, "update_an_account_parameters": { "additionalProperties": true, "example": { "name": "My renamed account" }, "properties": { "loan": { "additionalProperties": false, "description": "The loan details for the account.", "properties": { "credit_limit": { "description": "The maximum amount of money that can be drawn from the Account.", "minimum": 0, "type": "integer", "x-documentation-priority": "default" } }, "required": [ "credit_limit" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The new name of the Account.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] }, "update_an_entity_parameters": { "additionalProperties": false, "example": { "corporation": { "address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": "Unit 2", "state": "NY", "zip": "10045" } }, "risk_rating": { "rated_at": "2020-01-31T23:59:59Z", "rating": "low" } }, "properties": { "corporation": { "additionalProperties": true, "description": "Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail.", "properties": { "address": { "additionalProperties": false, "description": "The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "email": { "description": "An email address for the business. Not every program requires an email for submitted Entities.", "format": "email", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "incorporation_state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "industry_code": { "description": "The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like `5132` for `Software Publishers`. A full list of classification codes is available [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "legal_identifier": { "additionalProperties": false, "description": "The legal identifier of the corporation. This is usually the Employer Identification Number (EIN).", "properties": { "category": { "description": "The category of the legal identifier.", "enum": [ "us_employer_identification_number", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators.", "A legal identifier issued by a foreign government, like a tax identification number or registration number." ] }, "value": { "description": "The identifier of the legal identifier. For US Employer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "value" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The legal name of the corporation.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "details_confirmed_at": { "description": "When your user last confirmed the Entity's details. Depending on your program, you may be required to affirmatively confirm details with your users on an annual basis.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "government_authority": { "additionalProperties": false, "description": "Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail.", "properties": { "address": { "additionalProperties": false, "description": "The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP code of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "zip" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The legal name of the government authority.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "natural_person": { "additionalProperties": false, "description": "Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail.", "properties": { "address": { "additionalProperties": false, "description": "The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter ISO 3166-1 alpha-2 code for the country of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP or postal code of the address. Required in certain countries.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "confirmed_no_us_tax_id": { "description": "The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).", "type": "boolean", "x-documentation-priority": "default" }, "identification": { "additionalProperties": true, "description": "A means of verifying the person's identity.", "properties": { "drivers_license": { "additionalProperties": false, "description": "Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "expiration_date": { "description": "The driver's license's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the driver's license.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "state": { "description": "The state that issued the provided driver's license.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "file_id", "expiration_date", "state" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "method": { "description": "A method that can be used to verify the individual's identity.", "enum": [ "social_security_number", "individual_taxpayer_identification_number", "passport", "drivers_license", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A social security number.", "An individual taxpayer identification number (ITIN).", "A passport number.", "A driver's license number.", "Another identifying document." ] }, "number": { "description": "An identification number that can be used to verify the individual's identity, such as a social security number. For Social Security Numbers and Individual Taxpayer Identification Numbers, submit nine digits with no dashes or other separators.", "maxLength": 200, "minLength": 4, "type": "string", "x-documentation-priority": "default" }, "other": { "additionalProperties": false, "description": "Information about the identification document provided. Required if `method` is equal to `other`.", "properties": { "back_file_id": { "description": "The identifier of the File containing the back of the document. Not every document has a reverse side.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" }, "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "description": { "description": "A description of the document submitted.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The document's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the front of the document.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "country", "description", "file_id" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "passport": { "additionalProperties": false, "description": "Information about the passport used for identification. Required if `method` is equal to `passport`.", "properties": { "country": { "description": "The two-character ISO 3166-1 code representing the country that issued the document (e.g., `US`).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "expiration_date": { "description": "The passport's expiration date in YYYY-MM-DD format.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "file_id": { "description": "The identifier of the File containing the passport.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } }, "required": [ "file_id", "expiration_date", "country" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] } }, "required": [ "method", "number" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The legal name of the natural person.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "risk_rating": { "additionalProperties": false, "description": "An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.", "properties": { "rated_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "rating": { "description": "The rating given to this entity.", "enum": [ "low", "medium", "high" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Minimal risk of involvement in financial crime.", "Moderate risk of involvement in financial crime.", "Elevated risk of involvement in financial crime." ] } }, "required": [ "rating", "rated_at" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "terms_agreements": { "description": "New terms that the Entity agreed to. Not all programs are required to submit this data. This will not archive previously submitted terms.", "items": { "additionalProperties": false, "properties": { "agreed_at": { "description": "The timestamp of when the Entity agreed to the terms.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "ip_address": { "description": "The IP address the Entity accessed reviewed the terms from.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "terms_url": { "description": "The URL of the terms agreement. This link will be provided by your bank partner.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "terms_url", "ip_address", "agreed_at" ], "type": "object", "x-event-categories": [] }, "type": "array", "x-documentation-priority": "default" }, "third_party_verification": { "additionalProperties": false, "description": "If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.", "properties": { "reference": { "description": "The reference identifier for the third party verification.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "vendor": { "description": "The vendor that was used to perform the verification.", "enum": [ "alloy", "middesk", "oscilar", "persona", "taktile" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Alloy. See https://alloy.com for more information.", "Middesk. See https://middesk.com for more information.", "Oscilar. See https://oscilar.com for more information.", "Persona. See https://withpersona.com for more information.", "Taktile. See https://taktile.com for more information." ] } }, "required": [ "reference", "vendor" ], "type": "object", "x-documentation-priority": "low", "x-event-categories": [] }, "trust": { "additionalProperties": false, "description": "Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail.", "properties": { "address": { "additionalProperties": false, "description": "The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.", "properties": { "city": { "description": "The city of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address. This is usually the street number and street.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address. This might be the floor or room number.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "state": { "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "zip": { "description": "The ZIP code of the address.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "required": [ "line1", "city", "state", "zip" ], "type": "object", "x-documentation-priority": "default", "x-event-categories": [] }, "name": { "description": "The legal name of the trust.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-documentation-priority": "low", "x-event-categories": [] } }, "type": "object", "x-event-categories": [] }, "update_an_event_subscription_parameters": { "additionalProperties": false, "example": {}, "properties": { "status": { "description": "The status to update the Event Subscription with.", "enum": [ "active", "disabled", "deleted" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The subscription is active and Events will be delivered normally.", "The subscription is temporarily disabled and Events will not be delivered.", "The subscription is permanently disabled and Events will not be delivered." ] } }, "type": "object", "x-event-categories": [] }, "update_an_external_account_parameters": { "additionalProperties": false, "example": { "description": "New description" }, "properties": { "account_holder": { "description": "The type of entity that owns the External Account.", "enum": [ "business", "individual" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is owned by a business.", "The External Account is owned by an individual." ] }, "description": { "description": "The description you choose to give the external account.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" }, "funding": { "description": "The funding type of the External Account.", "enum": [ "checking", "savings", "general_ledger", "other" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "A checking account.", "A savings account.", "A general ledger account.", "A different type of account." ] }, "status": { "description": "The status of the External Account.", "enum": [ "active", "archived" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The External Account is active.", "The External Account is archived and won't appear in the dashboard." ] } }, "type": "object", "x-event-categories": [] }, "wire_drawdown_request": { "additionalProperties": true, "description": "Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to [support@increase.com](mailto:support@increase.com) to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).", "example": { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 10000, "created_at": "2020-01-31T23:59:59Z", "creditor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "debtor_external_account_id": null, "debtor_name": "Ian Crease", "debtor_routing_number": "101050001", "fulfillment_inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "id": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "idempotency_key": null, "status": "fulfilled", "submission": { "input_message_accountability_data": "20220118MMQFMP0P000003" }, "type": "wire_drawdown_request", "unstructured_remittance_information": "Invoice 29582" }, "properties": { "account_number_id": { "description": "The Account Number to which the debtor—the recipient of this request—is being requested to send funds.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" }, "amount": { "description": "The amount being requested in cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the wire drawdown request was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "creditor_address": { "additionalProperties": false, "description": "The creditor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The ZIP code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The address state.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "postal_code", "country" ], "title": "Wire Drawdown Request Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "creditor_name": { "description": "The creditor's name.", "type": "string", "x-documentation-priority": "default" }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be \"USD\".", "type": "string", "x-documentation-priority": "default" }, "debtor_account_number": { "description": "The debtor's account number.", "type": "string", "x-documentation-priority": "default" }, "debtor_address": { "additionalProperties": false, "description": "The debtor's address.", "properties": { "city": { "description": "The city, district, town, or village of the address.", "type": "string", "x-documentation-priority": "default" }, "country": { "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address.", "type": "string", "x-documentation-priority": "default" }, "line1": { "description": "The first line of the address.", "type": "string", "x-documentation-priority": "default" }, "line2": { "description": "The second line of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "postal_code": { "description": "The ZIP code of the address.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "state": { "description": "The address state.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "city", "state", "postal_code", "country" ], "title": "Wire Drawdown Request Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses" }, "debtor_external_account_id": { "description": "The debtor's external account identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts", "nullable": true }, "debtor_name": { "description": "The debtor's name.", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The debtor's routing number.", "type": "string", "x-documentation-priority": "default" }, "fulfillment_inbound_wire_transfer_id": { "description": "If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers", "nullable": true }, "id": { "description": "The Wire drawdown request identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "status": { "description": "The lifecycle status of the drawdown request.", "enum": [ "pending_submission", "fulfilled", "pending_response", "refused" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The drawdown request is queued to be submitted to Fedwire.", "The drawdown request has been fulfilled by the recipient.", "The drawdown request has been sent and the recipient should respond in some way.", "The drawdown request has been refused by the recipient." ] }, "submission": { "additionalProperties": false, "description": "After the drawdown request is submitted to Fedwire, this will contain supplemental details.", "example": { "input_message_accountability_data": "20220118MMQFMP0P000003" }, "properties": { "input_message_accountability_data": { "description": "The input message accountability data (IMAD) uniquely identifying the submission with Fedwire.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "input_message_accountability_data" ], "title": "Wire Drawdown Request Wire Drawdown Request Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Wire Drawdown Request Submissions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `wire_drawdown_request`.", "enum": [ "wire_drawdown_request" ], "type": "string", "x-documentation-priority": "default" }, "unstructured_remittance_information": { "description": "Remittance information the debtor will see as part of the drawdown request.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "type", "id", "created_at", "account_number_id", "debtor_account_number", "debtor_routing_number", "debtor_external_account_id", "amount", "currency", "unstructured_remittance_information", "debtor_name", "debtor_address", "creditor_name", "creditor_address", "submission", "fulfillment_inbound_wire_transfer_id", "status", "idempotency_key" ], "title": "Wire Drawdown Request", "type": "object", "x-event-categories": [ "wire_drawdown_request.created", "wire_drawdown_request.updated" ], "x-tag": "Wire Drawdown Requests", "x-title-plural": "Wire Drawdown Requests" }, "wire_drawdown_request_list": { "additionalProperties": true, "description": "A list of Wire Drawdown Request objects.", "example": { "data": [ { "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 10000, "created_at": "2020-01-31T23:59:59Z", "creditor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "debtor_external_account_id": null, "debtor_name": "Ian Crease", "debtor_routing_number": "101050001", "fulfillment_inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "id": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "idempotency_key": null, "status": "fulfilled", "submission": { "input_message_accountability_data": "20220118MMQFMP0P000003" }, "type": "wire_drawdown_request", "unstructured_remittance_information": "Invoice 29582" } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/wire_drawdown_request" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Wire Drawdown Request List", "type": "object", "x-event-categories": [], "x-title-plural": "Wire Drawdown Request Lists" }, "wire_transfer": { "additionalProperties": true, "description": "Wire transfers move funds between your Increase account and any other account accessible by Fedwire.", "example": { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor": { "address": { "unstructured": { "line1": "33 Liberty Street", "line2": null, "line3": null } }, "name": "National Phonograph Company" }, "currency": "USD", "debtor": null, "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "id": "wire_transfer_5akynk7dqsq25qwk9q2u", "idempotency_key": null, "inbound_wire_drawdown_request_id": null, "network": "wire", "pending_transaction_id": null, "remittance": { "category": "unstructured", "unstructured": { "message": "Invoice 29582" } }, "reversal": null, "routing_number": "101050001", "source_account_number_id": null, "status": "complete", "submission": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "wire_transfer", "unique_end_to_end_transaction_reference": null }, "properties": { "account_id": { "description": "The Account to which the transfer belongs.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" }, "account_number": { "description": "The destination account number.", "type": "string", "x-documentation-priority": "default" }, "amount": { "description": "The transfer amount in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "approval": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.", "example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "properties": { "approved_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "approved_by": { "description": "If the Transfer was approved by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "approved_at", "approved_by" ], "title": "Wire Transfer Transfer Approval", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Approvals", "nullable": true }, "cancellation": { "additionalProperties": false, "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.", "example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null }, "properties": { "canceled_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "canceled_by": { "description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "canceled_at", "canceled_by" ], "title": "Wire Transfer Transfer Cancellation", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Cancellations", "nullable": true }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "created_by": { "additionalProperties": false, "description": "What object created the transfer, either via the API or the dashboard.", "example": { "category": "user", "user": { "email": "user@example.com" } }, "properties": { "api_key": { "additionalProperties": false, "description": "If present, details about the API key that created the transfer.", "properties": { "description": { "description": "The description set for the API key when it was created.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "description" ], "title": "Wire Transfer Transfer Creator ApiKey", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "ApiKeys", "nullable": true }, "category": { "description": "The type of object that created this transfer.", "enum": [ "api_key", "oauth_application", "user" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "An API key. Details will be under the `api_key` object.", "An OAuth application you connected to Increase. Details will be under the `oauth_application` object.", "A User in the Increase dashboard. Details will be under the `user` object." ] }, "oauth_application": { "additionalProperties": false, "description": "If present, details about the OAuth Application that created the transfer.", "properties": { "name": { "description": "The name of the OAuth Application.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "name" ], "title": "Wire Transfer Transfer Creator OAuthApplication", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "OAuthApplications", "nullable": true }, "user": { "additionalProperties": false, "description": "If present, details about the User that created the transfer.", "properties": { "email": { "description": "The email address of the User.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "email" ], "title": "Wire Transfer Transfer Creator User", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Users", "nullable": true } }, "required": [ "category" ], "title": "Wire Transfer Transfer Creator", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Transfer Creators", "nullable": true }, "creditor": { "additionalProperties": false, "description": "The person or business that is receiving the funds from the transfer.", "properties": { "address": { "additionalProperties": false, "description": "The person or business's address.", "properties": { "unstructured": { "additionalProperties": false, "description": "Unstructured address lines.", "properties": { "line1": { "description": "The first line.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line2": { "description": "The second line.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line3": { "description": "The third line.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "line3" ], "title": "Wire Transfer Party Address Unstructured", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Unstructureds", "nullable": true } }, "required": [ "unstructured" ], "title": "Wire Transfer Party Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses", "nullable": true }, "name": { "description": "The person or business's name.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name", "address" ], "title": "Wire Transfer Party", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Parties", "nullable": true }, "currency": { "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For wire transfers this is always equal to `usd`.", "enum": [ "USD" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "US Dollar (USD)" ] }, "debtor": { "additionalProperties": false, "description": "The person or business whose funds are being transferred.", "properties": { "address": { "additionalProperties": false, "description": "The person or business's address.", "properties": { "unstructured": { "additionalProperties": false, "description": "Unstructured address lines.", "properties": { "line1": { "description": "The first line.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line2": { "description": "The second line.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "line3": { "description": "The third line.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "line1", "line2", "line3" ], "title": "Wire Transfer Party Address Unstructured", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Unstructureds", "nullable": true } }, "required": [ "unstructured" ], "title": "Wire Transfer Party Address", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Addresses", "nullable": true }, "name": { "description": "The person or business's name.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "name", "address" ], "title": "Wire Transfer Party", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Parties", "nullable": true }, "external_account_id": { "description": "The identifier of the External Account the transfer was made to, if any.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts", "nullable": true }, "id": { "description": "The wire transfer's identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" }, "idempotency_key": { "description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "inbound_wire_drawdown_request_id": { "description": "The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Drawdown Requests", "nullable": true }, "network": { "description": "The transfer's network.", "enum": [ "wire" ], "type": "string", "x-documentation-priority": "default" }, "pending_transaction_id": { "description": "The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions", "nullable": true }, "remittance": { "additionalProperties": false, "description": "Remittance information sent with the wire transfer.", "example": { "category": "unstructured", "unstructured": { "message": "Invoice 29582" } }, "properties": { "category": { "description": "The type of remittance information being passed.", "enum": [ "unstructured", "tax" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The wire transfer contains unstructured remittance information.", "The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS)." ] }, "tax": { "additionalProperties": false, "description": "Internal Revenue Service (IRS) tax repayment information. Required if `category` is equal to `tax`.", "properties": { "date": { "description": "The month and year the tax payment is for, in YYYY-MM-DD format. The day is ignored.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "identification_number": { "description": "The 9-digit Tax Identification Number (TIN) or Employer Identification Number (EIN).", "type": "string", "x-documentation-priority": "default" }, "type_code": { "description": "The 5-character tax type code.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "date", "type_code", "identification_number" ], "title": "Wire Transfer Wire Transfer Remittance information Tax", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Taxes", "nullable": true }, "unstructured": { "additionalProperties": false, "description": "Unstructured remittance information. Required if `category` is equal to `unstructured`.", "properties": { "message": { "description": "The message to the beneficiary.", "type": "string", "x-documentation-priority": "default" } }, "required": [ "message" ], "title": "Wire Transfer Wire Transfer Remittance information Unstructured", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Unstructureds", "nullable": true } }, "required": [ "category" ], "title": "Wire Transfer Wire Transfer Remittance information", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Wire Transfer Remittance information", "nullable": true }, "reversal": { "additionalProperties": true, "description": "If your transfer is reversed, this will contain details of the reversal.", "example": { "amount": 12345, "created_at": "2020-01-31T23:59:59Z", "debtor_routing_number": "101050001", "description": "Inbound wire reversal 2022021100335128", "input_cycle_date": "2022-02-11", "input_message_accountability_data": "20220211B6B7HU2R011023", "input_sequence_number": "11023", "input_source": "B6B7HU2R", "instruction_identification": null, "return_reason_additional_information": null, "return_reason_code": null, "return_reason_code_description": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "wire_transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u" }, "properties": { "amount": { "description": "The amount that was reversed in USD cents.", "type": "integer", "x-documentation-priority": "default" }, "created_at": { "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.", "format": "date-time", "type": "string", "x-documentation-priority": "default" }, "debtor_routing_number": { "description": "The debtor's routing number.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "description": { "description": "The description on the reversal message from Fedwire, set by the reversing bank.", "type": "string", "x-documentation-priority": "default" }, "input_cycle_date": { "description": "The Fedwire cycle date for the wire reversal. The \"Fedwire day\" begins at 9:00 PM Eastern Time on the evening before the `cycle date`.", "format": "date", "type": "string", "x-documentation-priority": "default" }, "input_message_accountability_data": { "description": "The Fedwire transaction identifier.", "type": "string", "x-documentation-priority": "default" }, "input_sequence_number": { "description": "The Fedwire sequence number.", "type": "string", "x-documentation-priority": "default" }, "input_source": { "description": "The Fedwire input source identifier.", "type": "string", "x-documentation-priority": "default" }, "instruction_identification": { "description": "The sending bank's identifier for the reversal.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason_additional_information": { "description": "Additional information about the reason for the reversal.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason_code": { "description": "A code provided by the sending bank giving a reason for the reversal. The common return reason codes are [documented here](/documentation/wire-reversals#reversal-reason-codes).", "type": "string", "x-documentation-priority": "default", "nullable": true }, "return_reason_code_description": { "description": "An Increase-generated description of the `return_reason_code`.", "type": "string", "x-documentation-priority": "default", "nullable": true }, "transaction_id": { "description": "The ID for the Transaction associated with the transfer reversal.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" }, "wire_transfer_id": { "description": "The ID for the Wire Transfer that is being reversed.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } }, "required": [ "amount", "created_at", "description", "input_cycle_date", "input_sequence_number", "input_source", "input_message_accountability_data", "transaction_id", "wire_transfer_id", "instruction_identification", "debtor_routing_number", "return_reason_code", "return_reason_code_description", "return_reason_additional_information" ], "title": "Wire Transfer Inbound Wire Reversal", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Inbound Wire Reversals", "nullable": true }, "routing_number": { "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).", "type": "string", "x-documentation-priority": "default" }, "source_account_number_id": { "description": "The Account Number that was passed to the wire's recipient.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers", "nullable": true }, "status": { "description": "The lifecycle status of the transfer.", "enum": [ "pending_approval", "canceled", "pending_reviewing", "rejected", "requires_attention", "pending_creating", "reversed", "submitted", "complete" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer has been rejected by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is pending creation.", "The transfer has been reversed.", "The transfer has been submitted to Fedwire.", "The transfer has been acknowledged by Fedwire and can be considered complete." ] }, "submission": { "additionalProperties": false, "description": "After the transfer is submitted to Fedwire, this will contain supplemental details.", "example": { "input_message_accountability_data": "20220118MMQFMP0P000002", "submitted_at": "2020-01-31T23:59:59Z" }, "properties": { "input_message_accountability_data": { "description": "The accountability data for the submission.", "type": "string", "x-documentation-priority": "default" }, "submitted_at": { "description": "When this wire transfer was submitted to Fedwire.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } }, "required": [ "input_message_accountability_data", "submitted_at" ], "title": "Wire Transfer Wire Transfer Submission", "type": "object", "x-documentation-priority": "default", "x-event-categories": [], "x-title-plural": "Wire Transfer Submissions", "nullable": true }, "transaction_id": { "description": "The ID for the transaction funding the transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions", "nullable": true }, "type": { "description": "A constant representing the object's type. For this resource it will always be `wire_transfer`.", "enum": [ "wire_transfer" ], "type": "string", "x-documentation-priority": "default" }, "unique_end_to_end_transaction_reference": { "description": "The unique end-to-end transaction reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "type", "id", "amount", "currency", "account_number", "remittance", "creditor", "debtor", "account_id", "source_account_number_id", "inbound_wire_drawdown_request_id", "external_account_id", "routing_number", "approval", "cancellation", "reversal", "created_at", "network", "status", "submission", "transaction_id", "pending_transaction_id", "created_by", "unique_end_to_end_transaction_reference", "idempotency_key" ], "title": "Wire Transfer", "type": "object", "x-event-categories": [ "wire_transfer.created", "wire_transfer.updated" ], "x-tag": "Wire Transfers", "x-title-plural": "Wire Transfers" }, "wire_transfer_list": { "additionalProperties": true, "description": "A list of Wire Transfer objects.", "example": { "data": [ { "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor": { "address": { "unstructured": { "line1": "33 Liberty Street", "line2": null, "line3": null } }, "name": "National Phonograph Company" }, "currency": "USD", "debtor": null, "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "id": "wire_transfer_5akynk7dqsq25qwk9q2u", "idempotency_key": null, "inbound_wire_drawdown_request_id": null, "network": "wire", "pending_transaction_id": null, "remittance": { "category": "unstructured", "unstructured": { "message": "Invoice 29582" } }, "reversal": null, "routing_number": "101050001", "source_account_number_id": null, "status": "complete", "submission": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "wire_transfer", "unique_end_to_end_transaction_reference": null } ], "next_cursor": "v57w5d" }, "properties": { "data": { "description": "The contents of the list.", "items": { "$ref": "#/components/schemas/wire_transfer" }, "type": "array", "x-documentation-priority": "default" }, "next_cursor": { "description": "A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.", "type": "string", "x-documentation-priority": "default", "nullable": true } }, "required": [ "data", "next_cursor" ], "title": "Wire Transfer List", "type": "object", "x-event-categories": [], "x-title-plural": "Wire Transfer Lists" }, "withdraw_a_card_dispute_parameters": { "additionalProperties": false, "example": { "explanation": "The explanation for withdrawing the Card Dispute." }, "properties": { "explanation": { "description": "The explanation for withdrawing the Card Dispute.", "maxLength": 2048, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, "type": "object", "x-event-categories": [] } }, "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!", "title": "Increase API", "version": "0.0.1" }, "openapi": "3.0.3", "paths": { "/account_numbers": { "get": { "operationId": "list_account_numbers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "The status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-enum-descriptions": [ "The account number is active.", "The account number is temporarily disabled.", "The account number is permanently disabled." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "ach_debit_status.in", "required": false, "schema": { "description": "The ACH Debit status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "allowed", "blocked" ], "type": "string", "x-enum-descriptions": [ "ACH Debits are allowed.", "ACH Debits are blocked." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Account Numbers to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_number_list" } } }, "description": "Account Number List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Account Numbers", "x-sandbox-only": false, "x-tag": "Account Numbers" }, "post": { "operationId": "create_an_account_number", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_account_number_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_number" } } }, "description": "Account Number" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Account Number", "x-sandbox-only": false, "x-tag": "Account Numbers" } }, "/account_numbers/{account_number_id}": { "get": { "operationId": "retrieve_an_account_number", "parameters": [ { "example": "account_number_v18nkfqm6afpsrvy82b2", "in": "path", "name": "account_number_id", "required": true, "schema": { "description": "The identifier of the Account Number to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_number" } } }, "description": "Account Number" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Account Number", "x-sandbox-only": false, "x-tag": "Account Numbers" }, "patch": { "operationId": "update_an_account_number", "parameters": [ { "example": "account_number_v18nkfqm6afpsrvy82b2", "in": "path", "name": "account_number_id", "required": true, "schema": { "description": "The identifier of the Account Number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_an_account_number_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_number" } } }, "description": "Account Number" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update an Account Number", "x-sandbox-only": false, "x-tag": "Account Numbers" } }, "/account_statements": { "get": { "operationId": "list_account_statements", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Account Statements to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "statement_period_start.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "statement_period_start.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "statement_period_start.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "statement_period_start.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_statement_list" } } }, "description": "Account Statement List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Account Statements", "x-sandbox-only": false, "x-tag": "Account Statements" } }, "/account_statements/{account_statement_id}": { "get": { "operationId": "retrieve_an_account_statement", "parameters": [ { "example": "account_statement_lkc03a4skm2k7f38vj15", "in": "path", "name": "account_statement_id", "required": true, "schema": { "description": "The identifier of the Account Statement to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Statements" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_statement" } } }, "description": "Account Statement" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Account Statement", "x-sandbox-only": false, "x-tag": "Account Statements" } }, "/account_transfers": { "get": { "operationId": "list_account_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Account Transfers to those that originated from the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_transfer_list" } } }, "description": "Account Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Account Transfers", "x-sandbox-only": false, "x-tag": "Account Transfers" }, "post": { "operationId": "create_an_account_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_account_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_transfer" } } }, "description": "Account Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Account Transfer", "x-sandbox-only": false, "x-tag": "Account Transfers" } }, "/account_transfers/{account_transfer_id}": { "get": { "operationId": "retrieve_an_account_transfer", "parameters": [ { "example": "account_transfer_7k9qe1ysdgqztnt63l7n", "in": "path", "name": "account_transfer_id", "required": true, "schema": { "description": "The identifier of the Account Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_transfer" } } }, "description": "Account Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Account Transfer", "x-sandbox-only": false, "x-tag": "Account Transfers" } }, "/account_transfers/{account_transfer_id}/approve": { "post": { "description": "Approves an Account Transfer in status `pending_approval`.", "operationId": "approve_an_account_transfer", "parameters": [ { "example": "account_transfer_7k9qe1ysdgqztnt63l7n", "in": "path", "name": "account_transfer_id", "required": true, "schema": { "description": "The identifier of the Account Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_transfer" } } }, "description": "Account Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve an Account Transfer", "x-sandbox-only": false, "x-tag": "Account Transfers" } }, "/account_transfers/{account_transfer_id}/cancel": { "post": { "description": "Cancels an Account Transfer in status `pending_approval`.", "operationId": "cancel_an_account_transfer", "parameters": [ { "example": "account_transfer_7k9qe1ysdgqztnt63l7n", "in": "path", "name": "account_transfer_id", "required": true, "schema": { "description": "The identifier of the pending Account Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_transfer" } } }, "description": "Account Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel an Account Transfer", "x-sandbox-only": false, "x-tag": "Account Transfers" } }, "/accounts": { "get": { "operationId": "list_accounts", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "entity_n8y8tnk2p9339ti393yi", "in": "query", "name": "entity_id", "required": false, "schema": { "description": "Filter Accounts for those belonging to the specified Entity.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } }, { "in": "query", "name": "informational_entity_id", "required": false, "schema": { "description": "Filter Accounts for those belonging to the specified Entity as informational.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } }, { "in": "query", "name": "program_id", "required": false, "schema": { "description": "Filter Accounts for those in a specific Program.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Accounts for those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "closed", "open" ], "type": "string", "x-enum-descriptions": [ "Closed Accounts on which no new activity can occur.", "Open Accounts that are ready to use." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_list" } } }, "description": "Account List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Accounts", "x-sandbox-only": false, "x-tag": "Accounts" }, "post": { "operationId": "create_an_account", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_account_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Account", "x-sandbox-only": false, "x-tag": "Accounts" } }, "/accounts/{account_id}": { "get": { "operationId": "retrieve_an_account", "parameters": [ { "example": "account_in71c4amph0vgo2qllky", "in": "path", "name": "account_id", "required": true, "schema": { "description": "The identifier of the Account to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Account", "x-sandbox-only": false, "x-tag": "Accounts" }, "patch": { "operationId": "update_an_account", "parameters": [ { "example": "account_in71c4amph0vgo2qllky", "in": "path", "name": "account_id", "required": true, "schema": { "description": "The identifier of the Account to update.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_an_account_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update an Account", "x-sandbox-only": false, "x-tag": "Accounts" } }, "/accounts/{account_id}/balance": { "get": { "description": "Retrieve the current and available balances for an account in minor units of the account's currency. Learn more about [account balances](/documentation/balance).", "operationId": "retrieve_an_account_balance", "parameters": [ { "example": "account_in71c4amph0vgo2qllky", "in": "path", "name": "account_id", "required": true, "schema": { "description": "The identifier of the Account to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "at_time", "required": false, "schema": { "description": "The moment to query the balance at. If not set, returns the current balances.", "format": "date-time", "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balance_lookup" } } }, "description": "Balance Lookup" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Account Balance", "x-sandbox-only": false, "x-tag": "Accounts" } }, "/accounts/{account_id}/close": { "post": { "operationId": "close_an_account", "parameters": [ { "example": "account_in71c4amph0vgo2qllky", "in": "path", "name": "account_id", "required": true, "schema": { "description": "The identifier of the Account to close. The account must have a zero balance.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } }, "description": "Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Close an Account", "x-sandbox-only": false, "x-tag": "Accounts" } }, "/accounts/{account_id}/intrafi_balance": { "get": { "description": "Returns the IntraFi balance for the given account. IntraFi may sweep funds to multiple banks. This endpoint will include both the total balance and the amount swept to each institution.", "operationId": "get_intrafi_balance", "parameters": [ { "example": "account_in71c4amph0vgo2qllky", "in": "path", "name": "account_id", "required": true, "schema": { "description": "The identifier of the Account to get balances for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_balance" } } }, "description": "IntraFi Balance" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Get IntraFi balance", "x-sandbox-only": false, "x-tag": "IntraFi Balances" } }, "/ach_prenotifications": { "get": { "operationId": "list_ach_prenotifications", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_prenotification_list" } } }, "description": "ACH Prenotification List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List ACH Prenotifications", "x-sandbox-only": false, "x-tag": "ACH Prenotifications" }, "post": { "operationId": "create_an_ach_prenotification", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_ach_prenotification_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_prenotification" } } }, "description": "ACH Prenotification" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an ACH Prenotification", "x-sandbox-only": false, "x-tag": "ACH Prenotifications" } }, "/ach_prenotifications/{ach_prenotification_id}": { "get": { "operationId": "retrieve_an_ach_prenotification", "parameters": [ { "example": "ach_prenotification_ubjf9qqsxl3obbcn1u34", "in": "path", "name": "ach_prenotification_id", "required": true, "schema": { "description": "The identifier of the ACH Prenotification to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Prenotifications" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_prenotification" } } }, "description": "ACH Prenotification" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an ACH Prenotification", "x-sandbox-only": false, "x-tag": "ACH Prenotifications" } }, "/ach_transfers": { "get": { "operationId": "list_ach_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter ACH Transfers to those that originated from the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "external_account_id", "required": false, "schema": { "description": "Filter ACH Transfers to those made to the specified External Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_approval", "pending_transfer_session_confirmation", "canceled", "pending_submission", "pending_reviewing", "requires_attention", "rejected", "submitted", "returned" ], "type": "string", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer belongs to a Transfer Session that is pending confirmation.", "The transfer has been canceled.", "The transfer is pending submission to the Federal Reserve.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer has been rejected.", "The transfer is complete.", "The transfer has been returned." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer_list" } } }, "description": "ACH Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List ACH Transfers", "x-sandbox-only": false, "x-tag": "ACH Transfers" }, "post": { "operationId": "create_an_ach_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an ACH Transfer", "x-sandbox-only": false, "x-tag": "ACH Transfers" } }, "/ach_transfers/{ach_transfer_id}": { "get": { "operationId": "retrieve_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an ACH Transfer", "x-sandbox-only": false, "x-tag": "ACH Transfers" } }, "/ach_transfers/{ach_transfer_id}/approve": { "post": { "description": "Approves an ACH Transfer in a pending_approval state.", "operationId": "approve_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve an ACH Transfer", "x-sandbox-only": false, "x-tag": "ACH Transfers" } }, "/ach_transfers/{ach_transfer_id}/cancel": { "post": { "description": "Cancels an ACH Transfer in a pending_approval state.", "operationId": "cancel_a_pending_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the pending ACH Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending ACH Transfer", "x-sandbox-only": false, "x-tag": "ACH Transfers" } }, "/card_disputes": { "get": { "operationId": "list_card_disputes", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "user_submission_required", "pending_user_submission_reviewing", "pending_user_submission_submitting", "pending_user_withdrawal_submitting", "pending_response", "lost", "won" ], "type": "string", "x-enum-descriptions": [ "A User Submission is required to continue with the Card Dispute.", "The most recent User Submission is being reviewed.", "The most recent User Submission is being submitted to the network.", "The user's withdrawal of the Card Dispute is being submitted to the network.", "The Card Dispute is pending a response from the network.", "The Card Dispute has been lost and funds previously credited from the acceptance have been debited.", "The Card Dispute has been won and no further action can be taken." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_dispute_list" } } }, "description": "Card Dispute List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Disputes", "x-sandbox-only": false, "x-tag": "Card Disputes" }, "post": { "operationId": "create_a_card_dispute", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_card_dispute_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_dispute" } } }, "description": "Card Dispute" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Card Dispute", "x-sandbox-only": false, "x-tag": "Card Disputes" } }, "/card_disputes/{card_dispute_id}": { "get": { "operationId": "retrieve_a_card_dispute", "parameters": [ { "example": "card_dispute_h9sc95nbl1cgltpp7men", "in": "path", "name": "card_dispute_id", "required": true, "schema": { "description": "The identifier of the Card Dispute.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Disputes" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_dispute" } } }, "description": "Card Dispute" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Dispute", "x-sandbox-only": false, "x-tag": "Card Disputes" } }, "/card_disputes/{card_dispute_id}/submit_user_submission": { "post": { "operationId": "submit_a_user_submission_for_a_card_dispute", "parameters": [ { "example": "card_dispute_h9sc95nbl1cgltpp7men", "in": "path", "name": "card_dispute_id", "required": true, "schema": { "description": "The identifier of the Card Dispute to submit a user submission for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Disputes" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/submit_a_user_submission_for_a_card_dispute_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_dispute" } } }, "description": "Card Dispute" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Submit a User Submission for a Card Dispute", "x-sandbox-only": false, "x-tag": "Card Disputes" } }, "/card_disputes/{card_dispute_id}/withdraw": { "post": { "operationId": "withdraw_a_card_dispute", "parameters": [ { "example": "card_dispute_h9sc95nbl1cgltpp7men", "in": "path", "name": "card_dispute_id", "required": true, "schema": { "description": "The identifier of the Card Dispute to withdraw.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Disputes" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/withdraw_a_card_dispute_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_dispute" } } }, "description": "Card Dispute" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Withdraw a Card Dispute", "x-sandbox-only": false, "x-tag": "Card Disputes" } }, "/card_payments": { "get": { "operationId": "list_card_payments", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Card Payments to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "card_id", "required": false, "schema": { "description": "Filter Card Payments to ones belonging to the specified Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment_list" } } }, "description": "Card Payment List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Payments", "x-sandbox-only": false, "x-tag": "Card Payments" } }, "/card_payments/{card_payment_id}": { "get": { "operationId": "retrieve_a_card_payment", "parameters": [ { "example": "card_payment_nd3k2kacrqjli8482ave", "in": "path", "name": "card_payment_id", "required": true, "schema": { "description": "The identifier of the Card Payment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Payment", "x-sandbox-only": false, "x-tag": "Card Payments" } }, "/card_purchase_supplements": { "get": { "operationId": "list_card_purchase_supplements", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "card_payment_nd3k2kacrqjli8482ave", "in": "query", "name": "card_payment_id", "required": false, "schema": { "description": "Filter Card Purchase Supplements to ones belonging to the specified Card Payment.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_purchase_supplement_list" } } }, "description": "Card Purchase Supplement List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Purchase Supplements", "x-sandbox-only": false, "x-tag": "Card Purchase Supplements" } }, "/card_purchase_supplements/{card_purchase_supplement_id}": { "get": { "operationId": "retrieve_a_card_purchase_supplement", "parameters": [ { "example": "card_purchase_supplement_ijuc45iym4jchnh2sfk3", "in": "path", "name": "card_purchase_supplement_id", "required": true, "schema": { "description": "The identifier of the Card Purchase Supplement.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Purchase Supplements" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_purchase_supplement" } } }, "description": "Card Purchase Supplement" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Purchase Supplement", "x-sandbox-only": false, "x-tag": "Card Purchase Supplements" } }, "/card_push_transfers": { "get": { "operationId": "list_card_push_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Card Push Transfers to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Card Push Transfers by status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_approval", "canceled", "pending_reviewing", "requires_attention", "pending_submission", "submitted", "complete", "declined" ], "type": "string", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is queued to be submitted to the card network.", "The transfer has been submitted and is pending a response from the card network.", "The transfer has been sent successfully and is complete.", "The transfer was declined by the network or the recipient's bank." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_push_transfer_list" } } }, "description": "Card Push Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Push Transfers", "x-sandbox-only": false, "x-tag": "Card Push Transfers" }, "post": { "operationId": "create_a_card_push_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_card_push_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_push_transfer" } } }, "description": "Card Push Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Card Push Transfer", "x-sandbox-only": false, "x-tag": "Card Push Transfers" } }, "/card_push_transfers/{card_push_transfer_id}": { "get": { "operationId": "retrieve_a_card_push_transfer", "parameters": [ { "example": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye", "in": "path", "name": "card_push_transfer_id", "required": true, "schema": { "description": "The identifier of the Card Push Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Push Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_push_transfer" } } }, "description": "Card Push Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Push Transfer", "x-sandbox-only": false, "x-tag": "Card Push Transfers" } }, "/card_push_transfers/{card_push_transfer_id}/approve": { "post": { "description": "Approves a Card Push Transfer in a pending_approval state.", "operationId": "approve_a_card_push_transfer", "parameters": [ { "example": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye", "in": "path", "name": "card_push_transfer_id", "required": true, "schema": { "description": "The identifier of the Card Push Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Push Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_push_transfer" } } }, "description": "Card Push Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve a Card Push Transfer", "x-sandbox-only": false, "x-tag": "Card Push Transfers" } }, "/card_push_transfers/{card_push_transfer_id}/cancel": { "post": { "description": "Cancels a Card Push Transfer in a pending_approval state.", "operationId": "cancel_a_pending_card_push_transfer", "parameters": [ { "example": "outbound_card_push_transfer_e0z9rdpamraczh4tvwye", "in": "path", "name": "card_push_transfer_id", "required": true, "schema": { "description": "The identifier of the pending Card Push Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Push Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_push_transfer" } } }, "description": "Card Push Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending Card Push Transfer", "x-sandbox-only": false, "x-tag": "Card Push Transfers" } }, "/card_tokens": { "get": { "operationId": "list_card_tokens", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_token_list" } } }, "description": "Card Token List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Tokens", "x-sandbox-only": false, "x-tag": "Card Tokens" } }, "/card_tokens/{card_token_id}": { "get": { "operationId": "retrieve_a_card_token", "parameters": [ { "example": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "in": "path", "name": "card_token_id", "required": true, "schema": { "description": "The identifier of the Card Token.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_token" } } }, "description": "Card Token" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Token", "x-sandbox-only": false, "x-tag": "Card Tokens" } }, "/card_tokens/{card_token_id}/capabilities": { "get": { "description": "The capabilities of a Card Token describe whether the card can be used for specific operations, such as Card Push Transfers. The capabilities can change over time based on the issuing bank's configuration of the card range.", "operationId": "retrieve_the_capabilities_of_a_card_token", "parameters": [ { "example": "outbound_card_token_zlt0ml6youq3q7vcdlg0", "in": "path", "name": "card_token_id", "required": true, "schema": { "description": "The identifier of the Card Token.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Tokens" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_token_capabilities" } } }, "description": "Card Token Capabilities" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve the capabilities of a Card Token", "x-sandbox-only": false, "x-tag": "Card Tokens" } }, "/card_validations": { "get": { "operationId": "list_card_validations", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Card Validations to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Card Validations by status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "requires_attention", "pending_submission", "submitted", "complete", "declined" ], "type": "string", "x-enum-descriptions": [ "The validation requires attention from an Increase operator.", "The validation is queued to be submitted to the card network.", "The validation has been submitted and is pending a response from the card network.", "The validation has been sent successfully and is complete.", "The validation was declined by the network or the recipient's bank." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_validation_list" } } }, "description": "Card Validation List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Validations", "x-sandbox-only": false, "x-tag": "Card Validations" }, "post": { "operationId": "create_a_card_validation", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_card_validation_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_validation" } } }, "description": "Card Validation" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Card Validation", "x-sandbox-only": false, "x-tag": "Card Validations" } }, "/card_validations/{card_validation_id}": { "get": { "operationId": "retrieve_a_card_validation", "parameters": [ { "example": "outbound_card_validation_qqlzagpc6v1x2gcdhe24", "in": "path", "name": "card_validation_id", "required": true, "schema": { "description": "The identifier of the Card Validation.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Validations" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_validation" } } }, "description": "Card Validation" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Validation", "x-sandbox-only": false, "x-tag": "Card Validations" } }, "/cards": { "get": { "operationId": "list_cards", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Cards to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Cards by status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "disabled", "canceled" ], "type": "string", "x-enum-descriptions": [ "The card is active.", "The card is temporarily disabled.", "The card is permanently canceled." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_list" } } }, "description": "Card List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Cards", "x-sandbox-only": false, "x-tag": "Cards" }, "post": { "operationId": "create_a_card", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_card_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card" } } }, "description": "Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Card", "x-sandbox-only": false, "x-tag": "Cards" } }, "/cards/{card_id}": { "get": { "operationId": "retrieve_a_card", "parameters": [ { "example": "card_oubs0hwk5rn6knuecxg2", "in": "path", "name": "card_id", "required": true, "schema": { "description": "The identifier of the Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card" } } }, "description": "Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card", "x-sandbox-only": false, "x-tag": "Cards" }, "patch": { "operationId": "update_a_card", "parameters": [ { "example": "card_oubs0hwk5rn6knuecxg2", "in": "path", "name": "card_id", "required": true, "schema": { "description": "The card identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_a_card_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card" } } }, "description": "Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update a Card", "x-sandbox-only": false, "x-tag": "Cards" } }, "/cards/{card_id}/create_details_iframe": { "post": { "description": "Create an iframe URL for a Card to display the card details. More details about styling and usage can be found in the [documentation](/documentation/embedded-card-component).", "operationId": "create_a_card_details_iframe", "parameters": [ { "example": "card_oubs0hwk5rn6knuecxg2", "in": "path", "name": "card_id", "required": true, "schema": { "description": "The identifier of the Card to create an iframe for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_card_details_iframe_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_iframe_url" } } }, "description": "Card iframe URL" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Card details iframe", "x-sandbox-only": false, "x-tag": "Cards" } }, "/cards/{card_id}/details": { "get": { "description": "Sensitive details for a Card include the primary account number, expiry, card verification code, and PIN.", "operationId": "retrieve_sensitive_details_for_a_card", "parameters": [ { "example": "card_oubs0hwk5rn6knuecxg2", "in": "path", "name": "card_id", "required": true, "schema": { "description": "The identifier of the Card to retrieve details for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_details" } } }, "description": "Card Details" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve sensitive details for a Card", "x-sandbox-only": false, "x-tag": "Cards" } }, "/cards/{card_id}/update_pin": { "post": { "operationId": "update_a_cards_pin", "parameters": [ { "example": "card_oubs0hwk5rn6knuecxg2", "in": "path", "name": "card_id", "required": true, "schema": { "description": "The identifier of the Card to update the PIN for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_a_cards_pin_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_details" } } }, "description": "Card Details" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update a Card's PIN", "x-sandbox-only": false, "x-tag": "Cards" } }, "/check_deposits": { "get": { "operationId": "list_check_deposits", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Check Deposits to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit_list" } } }, "description": "Check Deposit List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Check Deposits", "x-sandbox-only": false, "x-tag": "Check Deposits" }, "post": { "operationId": "create_a_check_deposit", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_check_deposit_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit" } } }, "description": "Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Check Deposit", "x-sandbox-only": false, "x-tag": "Check Deposits" } }, "/check_deposits/{check_deposit_id}": { "get": { "operationId": "retrieve_a_check_deposit", "parameters": [ { "example": "check_deposit_f06n9gpg7sxn8t19lfc1", "in": "path", "name": "check_deposit_id", "required": true, "schema": { "description": "The identifier of the Check Deposit to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit" } } }, "description": "Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Check Deposit", "x-sandbox-only": false, "x-tag": "Check Deposits" } }, "/check_transfers": { "get": { "operationId": "list_check_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Check Transfers to those that originated from the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Check Transfers to those that have the specified status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_approval", "canceled", "pending_submission", "requires_attention", "rejected", "pending_mailing", "mailed", "deposited", "stopped", "returned" ], "type": "string", "x-enum-descriptions": [ "The transfer is awaiting approval.", "The transfer has been canceled.", "The transfer is pending submission.", "The transfer requires attention from an Increase operator.", "The transfer has been rejected.", "The check is queued for mailing.", "The check has been mailed.", "The check has been deposited.", "A stop-payment was requested for this check.", "The transfer has been returned." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer_list" } } }, "description": "Check Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Check Transfers", "x-sandbox-only": false, "x-tag": "Check Transfers" }, "post": { "operationId": "create_a_check_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_check_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer" } } }, "description": "Check Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Check Transfer", "x-sandbox-only": false, "x-tag": "Check Transfers" } }, "/check_transfers/{check_transfer_id}": { "get": { "operationId": "retrieve_a_check_transfer", "parameters": [ { "example": "check_transfer_30b43acfu9vw8fyc4f5", "in": "path", "name": "check_transfer_id", "required": true, "schema": { "description": "The identifier of the Check Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer" } } }, "description": "Check Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Check Transfer", "x-sandbox-only": false, "x-tag": "Check Transfers" } }, "/check_transfers/{check_transfer_id}/approve": { "post": { "operationId": "approve_a_check_transfer", "parameters": [ { "example": "check_transfer_30b43acfu9vw8fyc4f5", "in": "path", "name": "check_transfer_id", "required": true, "schema": { "description": "The identifier of the Check Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer" } } }, "description": "Check Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve a Check Transfer", "x-sandbox-only": false, "x-tag": "Check Transfers" } }, "/check_transfers/{check_transfer_id}/cancel": { "post": { "description": "Cancel a Check Transfer with the `pending_approval` status. See [Transfer Approvals](/documentation/transfer-approvals) for more information.", "operationId": "cancel_a_pending_check_transfer", "parameters": [ { "example": "check_transfer_30b43acfu9vw8fyc4f5", "in": "path", "name": "check_transfer_id", "required": true, "schema": { "description": "The identifier of the pending Check Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer" } } }, "description": "Check Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending Check Transfer", "x-sandbox-only": false, "x-tag": "Check Transfers" } }, "/check_transfers/{check_transfer_id}/stop_payment": { "post": { "operationId": "stop_payment_on_a_check_transfer", "parameters": [ { "example": "check_transfer_30b43acfu9vw8fyc4f5", "in": "path", "name": "check_transfer_id", "required": true, "schema": { "description": "The identifier of the Check Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stop_payment_on_a_check_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer" } } }, "description": "Check Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Stop payment on a Check Transfer", "x-sandbox-only": false, "x-tag": "Check Transfers" } }, "/declined_transactions": { "get": { "operationId": "list_declined_transactions", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Declined Transactions to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "route_id", "required": false, "schema": { "description": "Filter Declined Transactions to those belonging to the specified route.", "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "category.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "ach_decline", "card_decline", "check_decline", "inbound_real_time_payments_transfer_decline", "inbound_fednow_transfer_decline", "wire_decline", "check_deposit_rejection", "other" ], "type": "string", "x-enum-descriptions": [ "ACH Decline: details will be under the `ach_decline` object.", "Card Decline: details will be under the `card_decline` object.", "Check Decline: details will be under the `check_decline` object.", "Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.", "Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.", "Wire Decline: details will be under the `wire_decline` object.", "Check Deposit Rejection: details will be under the `check_deposit_rejection` object.", "The Declined Transaction was made for an undocumented or deprecated reason." ] }, "type": "array", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/declined_transaction_list" } } }, "description": "Declined Transaction List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Declined Transactions", "x-sandbox-only": false, "x-tag": "Declined Transactions" } }, "/declined_transactions/{declined_transaction_id}": { "get": { "operationId": "retrieve_a_declined_transaction", "parameters": [ { "example": "declined_transaction_17jbn0yyhvkt4v4ooym8", "in": "path", "name": "declined_transaction_id", "required": true, "schema": { "description": "The identifier of the Declined Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Declined Transactions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/declined_transaction" } } }, "description": "Declined Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Declined Transaction", "x-sandbox-only": false, "x-tag": "Declined Transactions" } }, "/digital_card_profiles": { "get": { "operationId": "list_card_profiles", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Digital Card Profiles for those with the specified digital wallet status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending", "rejected", "active", "archived" ], "type": "string", "x-enum-descriptions": [ "The Card Profile is awaiting review from Increase and/or processing by card networks.", "There is an issue with the Card Profile preventing it from use.", "The Card Profile can be assigned to Cards.", "The Card Profile is no longer in use." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_card_profile_list" } } }, "description": "Digital Card Profile List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Card Profiles", "x-sandbox-only": false, "x-tag": "Digital Card Profiles" }, "post": { "operationId": "create_a_digital_card_profile", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_digital_card_profile_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_card_profile" } } }, "description": "Digital Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Digital Card Profile", "x-sandbox-only": false, "x-tag": "Digital Card Profiles" } }, "/digital_card_profiles/{digital_card_profile_id}": { "get": { "operationId": "retrieve_a_digital_card_profile", "parameters": [ { "example": "digital_card_profile_s3puplu90f04xhcwkiga", "in": "path", "name": "digital_card_profile_id", "required": true, "schema": { "description": "The identifier of the Digital Card Profile.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_card_profile" } } }, "description": "Digital Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Digital Card Profile", "x-sandbox-only": false, "x-tag": "Digital Card Profiles" } }, "/digital_card_profiles/{digital_card_profile_id}/archive": { "post": { "operationId": "archive_a_digital_card_profile", "parameters": [ { "example": "digital_card_profile_s3puplu90f04xhcwkiga", "in": "path", "name": "digital_card_profile_id", "required": true, "schema": { "description": "The identifier of the Digital Card Profile to archive.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_card_profile" } } }, "description": "Digital Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Archive a Digital Card Profile", "x-sandbox-only": false, "x-tag": "Digital Card Profiles" } }, "/digital_card_profiles/{digital_card_profile_id}/clone": { "post": { "operationId": "clones_a_digital_card_profile", "parameters": [ { "example": "digital_card_profile_s3puplu90f04xhcwkiga", "in": "path", "name": "digital_card_profile_id", "required": true, "schema": { "description": "The identifier of the Digital Card Profile to clone.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Card Profiles" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clones_a_digital_card_profile_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_card_profile" } } }, "description": "Digital Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Clones a Digital Card Profile", "x-sandbox-only": false, "x-tag": "Digital Card Profiles" } }, "/digital_wallet_tokens": { "get": { "operationId": "list_digital_wallet_tokens", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "card_oubs0hwk5rn6knuecxg2", "in": "query", "name": "card_id", "required": false, "schema": { "description": "Filter Digital Wallet Tokens to ones belonging to the specified Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_wallet_token_list" } } }, "description": "Digital Wallet Token List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Digital Wallet Tokens", "x-sandbox-only": false, "x-tag": "Digital Wallet Tokens" } }, "/digital_wallet_tokens/{digital_wallet_token_id}": { "get": { "operationId": "retrieve_a_digital_wallet_token", "parameters": [ { "example": "digital_wallet_token_izi62go3h51p369jrie0", "in": "path", "name": "digital_wallet_token_id", "required": true, "schema": { "description": "The identifier of the Digital Wallet Token.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Digital Wallet Tokens" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/digital_wallet_token" } } }, "description": "Digital Wallet Token" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Digital Wallet Token", "x-sandbox-only": false, "x-tag": "Digital Wallet Tokens" } }, "/entities": { "get": { "operationId": "list_entities", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Entities for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "archived", "disabled" ], "type": "string", "x-enum-descriptions": [ "The entity is active.", "The entity is archived, and can no longer be used to create accounts.", "The entity is temporarily disabled and cannot be used for financial activity." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_list" } } }, "description": "Entity List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Entities", "x-sandbox-only": false, "x-tag": "Entities" }, "post": { "operationId": "create_an_entity", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_entity_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity" } } }, "description": "Entity" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Entity", "x-sandbox-only": false, "x-tag": "Entities" } }, "/entities/{entity_id}": { "get": { "operationId": "retrieve_an_entity", "parameters": [ { "example": "entity_n8y8tnk2p9339ti393yi", "in": "path", "name": "entity_id", "required": true, "schema": { "description": "The identifier of the Entity to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity" } } }, "description": "Entity" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Entity", "x-sandbox-only": false, "x-tag": "Entities" }, "patch": { "operationId": "update_an_entity", "parameters": [ { "example": "entity_n8y8tnk2p9339ti393yi", "in": "path", "name": "entity_id", "required": true, "schema": { "description": "The entity identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_an_entity_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity" } } }, "description": "Entity" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update an Entity", "x-sandbox-only": false, "x-tag": "Entities" } }, "/entities/{entity_id}/archive": { "post": { "operationId": "archive_an_entity", "parameters": [ { "example": "entity_n8y8tnk2p9339ti393yi", "in": "path", "name": "entity_id", "required": true, "schema": { "description": "The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity" } } }, "description": "Entity" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Archive an Entity", "x-sandbox-only": false, "x-tag": "Entities" } }, "/entity_beneficial_owners": { "get": { "operationId": "list_beneficial_owners", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "entity_n8y8tnk2p9339ti393yi", "in": "query", "name": "entity_id", "required": true, "schema": { "description": "The identifier of the Entity to list beneficial owners for. Only `corporation` entities have beneficial owners.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_beneficial_owner_list" } } }, "description": "Beneficial Owner List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Beneficial Owners", "x-sandbox-only": false, "x-tag": "Beneficial Owners" }, "post": { "operationId": "create_a_beneficial_owner", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_beneficial_owner_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_beneficial_owner" } } }, "description": "Beneficial Owner" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Beneficial Owner", "x-sandbox-only": false, "x-tag": "Beneficial Owners" } }, "/entity_beneficial_owners/{entity_beneficial_owner_id}": { "get": { "operationId": "retrieve_a_beneficial_owner", "parameters": [ { "example": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "in": "path", "name": "entity_beneficial_owner_id", "required": true, "schema": { "description": "The identifier of the Beneficial Owner to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_beneficial_owner" } } }, "description": "Beneficial Owner" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Beneficial Owner", "x-sandbox-only": false, "x-tag": "Beneficial Owners" }, "patch": { "operationId": "update_a_beneficial_owner", "parameters": [ { "example": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "in": "path", "name": "entity_beneficial_owner_id", "required": true, "schema": { "description": "The identifier of the Beneficial Owner to update.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_a_beneficial_owner_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_beneficial_owner" } } }, "description": "Beneficial Owner" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update a Beneficial Owner", "x-sandbox-only": false, "x-tag": "Beneficial Owners" } }, "/entity_beneficial_owners/{entity_beneficial_owner_id}/archive": { "post": { "operationId": "archive_a_beneficial_owner", "parameters": [ { "example": "entity_beneficial_owner_vozma8szzu1sxezp5zq6", "in": "path", "name": "entity_beneficial_owner_id", "required": true, "schema": { "description": "The identifier of the Beneficial Owner to archive.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Beneficial Owners" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_beneficial_owner" } } }, "description": "Beneficial Owner" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Archive a Beneficial Owner", "x-sandbox-only": false, "x-tag": "Beneficial Owners" } }, "/entity_onboarding_sessions": { "get": { "operationId": "list_entity_onboarding_session", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Entity Onboarding Session for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "expired" ], "type": "string", "x-enum-descriptions": [ "The Entity Onboarding Session is active.", "The Entity Onboarding Session has expired." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_onboarding_session_list" } } }, "description": "Entity Onboarding Session List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Entity Onboarding Session", "x-sandbox-only": false, "x-tag": "Entity Onboarding Sessions" }, "post": { "operationId": "create_an_entity_onboarding_session", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_entity_onboarding_session_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_onboarding_session" } } }, "description": "Entity Onboarding Session" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Entity Onboarding Session", "x-sandbox-only": false, "x-tag": "Entity Onboarding Sessions" } }, "/entity_onboarding_sessions/{entity_onboarding_session_id}": { "get": { "operationId": "retrieve_an_entity_onboarding_session", "parameters": [ { "example": "entity_onboarding_session_wid2ug11fsmvh3k9hymd", "in": "path", "name": "entity_onboarding_session_id", "required": true, "schema": { "description": "The identifier of the Entity Onboarding Session.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entity Onboarding Sessions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_onboarding_session" } } }, "description": "Entity Onboarding Session" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Entity Onboarding Session", "x-sandbox-only": false, "x-tag": "Entity Onboarding Sessions" } }, "/entity_onboarding_sessions/{entity_onboarding_session_id}/expire": { "post": { "operationId": "expire_an_entity_onboarding_session", "parameters": [ { "example": "entity_onboarding_session_wid2ug11fsmvh3k9hymd", "in": "path", "name": "entity_onboarding_session_id", "required": true, "schema": { "description": "The identifier of the Entity Onboarding Session to expire.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entity Onboarding Sessions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_onboarding_session" } } }, "description": "Entity Onboarding Session" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Expire an Entity Onboarding Session", "x-sandbox-only": false, "x-tag": "Entity Onboarding Sessions" } }, "/entity_supplemental_documents": { "get": { "operationId": "list_entity_supplemental_document_submissions", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "entity_n8y8tnk2p9339ti393yi", "in": "query", "name": "entity_id", "required": true, "schema": { "description": "The identifier of the Entity to list supplemental documents for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_supplemental_document_list" } } }, "description": "Supplemental Document List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Entity Supplemental Document Submissions", "x-sandbox-only": false, "x-tag": "Supplemental Documents" }, "post": { "operationId": "create_a_supplemental_document_for_an_entity", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_supplemental_document_for_an_entity_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_supplemental_document" } } }, "description": "Supplemental Document" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a supplemental document for an Entity", "x-sandbox-only": false, "x-tag": "Supplemental Documents" } }, "/event_subscriptions": { "get": { "operationId": "list_event_subscriptions", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_subscription_list" } } }, "description": "Event Subscription List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Event Subscriptions", "x-sandbox-only": false, "x-tag": "Event Subscriptions" }, "post": { "operationId": "create_an_event_subscription", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_event_subscription_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_subscription" } } }, "description": "Event Subscription" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Event Subscription", "x-sandbox-only": false, "x-tag": "Event Subscriptions" } }, "/event_subscriptions/{event_subscription_id}": { "get": { "operationId": "retrieve_an_event_subscription", "parameters": [ { "example": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "in": "path", "name": "event_subscription_id", "required": true, "schema": { "description": "The identifier of the Event Subscription.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Event Subscriptions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_subscription" } } }, "description": "Event Subscription" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Event Subscription", "x-sandbox-only": false, "x-tag": "Event Subscriptions" }, "patch": { "operationId": "update_an_event_subscription", "parameters": [ { "example": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "in": "path", "name": "event_subscription_id", "required": true, "schema": { "description": "The identifier of the Event Subscription.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Event Subscriptions" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_an_event_subscription_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_subscription" } } }, "description": "Event Subscription" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update an Event Subscription", "x-sandbox-only": false, "x-tag": "Event Subscriptions" } }, "/events": { "get": { "operationId": "list_events", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "category.in", "required": false, "schema": { "description": "Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "blockchain_address.created", "blockchain_address.updated", "blockchain_offramp_transfer.created", "blockchain_offramp_transfer.updated", "blockchain_onramp_transfer.created", "blockchain_onramp_transfer.updated", "bookkeeping_account.created", "bookkeeping_account.updated", "bookkeeping_entry_set.updated", "card.created", "card.updated", "card_payment.created", "card_payment.updated", "card_purchase_supplement.created", "card_profile.created", "card_profile.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_card_profile.created", "digital_card_profile.updated", "digital_wallet_token.created", "digital_wallet_token.updated", "entity.created", "entity.updated", "event_subscription.created", "event_subscription.updated", "export.created", "export.updated", "external_account.created", "external_account.updated", "fednow_transfer.created", "fednow_transfer.updated", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer.created", "inbound_ach_transfer.updated", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_check_deposit.created", "inbound_check_deposit.updated", "inbound_fednow_transfer.created", "inbound_fednow_transfer.updated", "inbound_mail_item.created", "inbound_mail_item.updated", "inbound_real_time_payments_transfer.created", "inbound_real_time_payments_transfer.updated", "inbound_wire_drawdown_request.created", "inbound_wire_transfer.created", "inbound_wire_transfer.updated", "intrafi_account_enrollment.created", "intrafi_account_enrollment.updated", "intrafi_exclusion.created", "intrafi_exclusion.updated", "lockbox.created", "lockbox.updated", "oauth_connection.created", "oauth_connection.deactivated", "card_push_transfer.created", "card_push_transfer.updated", "card_validation.created", "card_validation.updated", "pending_transaction.created", "pending_transaction.updated", "physical_card.created", "physical_card.updated", "physical_card_profile.created", "physical_card_profile.updated", "physical_check.created", "physical_check.updated", "program.created", "program.updated", "proof_of_authorization_request.created", "proof_of_authorization_request.updated", "real_time_decision.card_authorization_requested", "real_time_decision.card_balance_inquiry_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_decision.card_authentication_requested", "real_time_decision.card_authentication_challenge_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "swift_transfer.created", "swift_transfer.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated" ], "type": "string", "x-enum-descriptions": [ "Occurs whenever an Account is created.", "Occurs whenever an Account is updated.", "Occurs whenever an Account Number is created.", "Occurs whenever an Account Number is updated.", "Occurs whenever an Account Statement is created.", "Occurs whenever an Account Transfer is created.", "Occurs whenever an Account Transfer is updated.", "Occurs whenever an ACH Prenotification is created.", "Occurs whenever an ACH Prenotification is updated.", "Occurs whenever an ACH Transfer is created.", "Occurs whenever an ACH Transfer is updated.", "Occurs whenever a Blockchain Address is created.", "Occurs whenever a Blockchain Address is updated.", "Occurs whenever a Blockchain Off-Ramp Transfer is created.", "Occurs whenever a Blockchain Off-Ramp Transfer is updated.", "Occurs whenever a Blockchain On-Ramp Transfer is created.", "Occurs whenever a Blockchain On-Ramp Transfer is updated.", "Occurs whenever a Bookkeeping Account is created.", "Occurs whenever a Bookkeeping Account is updated.", "Occurs whenever a Bookkeeping Entry Set is created.", "Occurs whenever a Card is created.", "Occurs whenever a Card is updated.", "Occurs whenever a Card Payment is created.", "Occurs whenever a Card Payment is updated.", "Occurs whenever a Card Purchase Supplement is created.", "Occurs whenever a Card Profile is created.", "Occurs whenever a Card Profile is updated.", "Occurs whenever a Card Dispute is created.", "Occurs whenever a Card Dispute is updated.", "Occurs whenever a Check Deposit is created.", "Occurs whenever a Check Deposit is updated.", "Occurs whenever a Check Transfer is created.", "Occurs whenever a Check Transfer is updated.", "Occurs whenever a Declined Transaction is created.", "Occurs whenever a Digital Card Profile is created.", "Occurs whenever a Digital Card Profile is updated.", "Occurs whenever a Digital Wallet Token is created.", "Occurs whenever a Digital Wallet Token is updated.", "Occurs whenever an Entity is created.", "Occurs whenever an Entity is updated.", "Occurs whenever an Event Subscription is created.", "Occurs whenever an Event Subscription is updated.", "Occurs whenever an Export is created.", "Occurs whenever an Export is updated.", "Occurs whenever an External Account is created.", "Occurs whenever an External Account is updated.", "Occurs whenever a FedNow Transfer is created.", "Occurs whenever a FedNow Transfer is updated.", "Occurs whenever a File is created.", "Occurs whenever a Group is updated.", "Increase may send webhooks with this category to see if a webhook endpoint is working properly.", "Occurs whenever an Inbound ACH Transfer is created.", "Occurs whenever an Inbound ACH Transfer is updated.", "Occurs whenever an Inbound ACH Transfer Return is created.", "Occurs whenever an Inbound ACH Transfer Return is updated.", "Occurs whenever an Inbound Check Deposit is created.", "Occurs whenever an Inbound Check Deposit is updated.", "Occurs whenever an Inbound FedNow Transfer is created.", "Occurs whenever an Inbound FedNow Transfer is updated.", "Occurs whenever an Inbound Mail Item is created.", "Occurs whenever an Inbound Mail Item is updated.", "Occurs whenever an Inbound Real-Time Payments Transfer is created.", "Occurs whenever an Inbound Real-Time Payments Transfer is updated.", "Occurs whenever an Inbound Wire Drawdown Request is created.", "Occurs whenever an Inbound Wire Transfer is created.", "Occurs whenever an Inbound Wire Transfer is updated.", "Occurs whenever an IntraFi Account Enrollment is created.", "Occurs whenever an IntraFi Account Enrollment is updated.", "Occurs whenever an IntraFi Exclusion is created.", "Occurs whenever an IntraFi Exclusion is updated.", "Occurs whenever a Lockbox is created.", "Occurs whenever a Lockbox is updated.", "Occurs whenever an OAuth Connection is created.", "Occurs whenever an OAuth Connection is deactivated.", "Occurs whenever a Card Push Transfer is created.", "Occurs whenever a Card Push Transfer is updated.", "Occurs whenever a Card Validation is created.", "Occurs whenever a Card Validation is updated.", "Occurs whenever a Pending Transaction is created.", "Occurs whenever a Pending Transaction is updated.", "Occurs whenever a Physical Card is created.", "Occurs whenever a Physical Card is updated.", "Occurs whenever a Physical Card Profile is created.", "Occurs whenever a Physical Card Profile is updated.", "Occurs whenever a Physical Check is created.", "Occurs whenever a Physical Check is updated.", "Occurs whenever a Program is created.", "Occurs whenever a Program is updated.", "Occurs whenever a Proof of Authorization Request is created.", "Occurs whenever a Proof of Authorization Request is updated.", "Occurs whenever a Real-Time Decision is created in response to a card authorization.", "Occurs whenever a Real-Time Decision is created in response to a card balance inquiry.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.", "Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication.", "Occurs whenever a Real-Time Decision is created in response to 3DS authentication challenges.", "Occurs whenever a Real-Time Payments Transfer is created.", "Occurs whenever a Real-Time Payments Transfer is updated.", "Occurs whenever a Real-Time Payments Request for Payment is created.", "Occurs whenever a Real-Time Payments Request for Payment is updated.", "Occurs whenever a Swift Transfer is created.", "Occurs whenever a Swift Transfer is updated.", "Occurs whenever a Transaction is created.", "Occurs whenever a Wire Drawdown Request is created.", "Occurs whenever a Wire Drawdown Request is updated.", "Occurs whenever a Wire Transfer is created.", "Occurs whenever a Wire Transfer is updated." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "associated_object_id", "required": false, "schema": { "description": "Filter Events to those belonging to the object with the provided identifier.", "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "order_by.direction", "required": false, "schema": { "description": "The direction to order in.", "enum": [ "ascending", "descending" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Ascending in value.", "Descending in value." ] } }, { "in": "query", "name": "order_by.field", "required": false, "schema": { "description": "The field to order by.", "enum": [ "created_at" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "The time the Event was created." ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_list" } } }, "description": "Event List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Events", "x-sandbox-only": false, "x-tag": "Events" } }, "/events/{event_id}": { "get": { "operationId": "retrieve_an_event", "parameters": [ { "example": "event_001dzz0r20rzr4zrhrr1364hy80", "in": "path", "name": "event_id", "required": true, "schema": { "description": "The identifier of the Event.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Events" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event" } } }, "description": "Event" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Event", "x-sandbox-only": false, "x-tag": "Events" } }, "/exports": { "get": { "operationId": "list_exports", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "category", "required": false, "schema": { "description": "Filter Exports for those with the specified category.", "enum": [ "account_statement_ofx", "account_statement_bai2", "transaction_csv", "balance_csv", "bookkeeping_account_balance_csv", "entity_csv", "vendor_csv", "dashboard_table_csv", "account_verification_letter", "funding_instructions", "form_1099_int", "form_1099_misc", "fee_csv", "voided_check", "daily_account_balance_csv" ], "type": "string", "x-documentation-priority": "default", "x-enum-descriptions": [ "Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.", "Export a BAI2 file of transactions and balances for a given date and optional Account.", "Export a CSV of all transactions for a given time range.", "Export a CSV of account balances for the dates in a given range.", "Export a CSV of bookkeeping account balances for the dates in a given range.", "Export a CSV of entities with a given status.", "Export a CSV of vendors added to the third-party risk management dashboard.", "Certain dashboard tables are available as CSV exports. This export cannot be created via the API.", "A PDF of an account verification letter.", "A PDF of funding instructions.", "A PDF of an Internal Revenue Service Form 1099-INT.", "A PDF of an Internal Revenue Service Form 1099-MISC.", "Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.", "A PDF of a voided check.", "Export a CSV of daily account balances with starting and ending balances for a given date range." ] } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Exports for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending", "complete", "failed" ], "type": "string", "x-enum-descriptions": [ "Increase is generating the export.", "The export has been successfully generated.", "The export failed to generate. Increase will reach out to you to resolve the issue." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "form_1099_int.account_id", "required": false, "schema": { "description": "Filter Form 1099-INT Exports to those for the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "form_1099_misc.account_id", "required": false, "schema": { "description": "Filter Form 1099-MISC Exports to those for the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export_list" } } }, "description": "Export List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Exports", "x-sandbox-only": false, "x-tag": "Exports" }, "post": { "operationId": "create_an_export", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_export_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export" } } }, "description": "Export" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an Export", "x-sandbox-only": false, "x-tag": "Exports" } }, "/exports/{export_id}": { "get": { "operationId": "retrieve_an_export", "parameters": [ { "example": "export_8s4m48qz3bclzje0zwh9", "in": "path", "name": "export_id", "required": true, "schema": { "description": "The identifier of the Export to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Exports" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export" } } }, "description": "Export" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Export", "x-sandbox-only": false, "x-tag": "Exports" } }, "/external_accounts": { "get": { "operationId": "list_external_accounts", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "archived" ], "type": "string", "x-enum-descriptions": [ "The External Account is active.", "The External Account is archived and won't appear in the dashboard." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "routing_number", "required": false, "schema": { "description": "Filter External Accounts to those with the specified Routing Number.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account_list" } } }, "description": "External Account List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List External Accounts", "x-sandbox-only": false, "x-tag": "External Accounts" }, "post": { "operationId": "create_an_external_account", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_external_account_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "External Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an External Account", "x-sandbox-only": false, "x-tag": "External Accounts" } }, "/external_accounts/{external_account_id}": { "get": { "operationId": "retrieve_an_external_account", "parameters": [ { "example": "external_account_ukk55lr923a3ac0pp7iv", "in": "path", "name": "external_account_id", "required": true, "schema": { "description": "The identifier of the External Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "External Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an External Account", "x-sandbox-only": false, "x-tag": "External Accounts" }, "patch": { "operationId": "update_an_external_account", "parameters": [ { "example": "external_account_ukk55lr923a3ac0pp7iv", "in": "path", "name": "external_account_id", "required": true, "schema": { "description": "The external account identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_an_external_account_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/external_account" } } }, "description": "External Account" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update an External Account", "x-sandbox-only": false, "x-tag": "External Accounts" } }, "/fednow_transfers": { "get": { "operationId": "list_fednow_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter FedNow Transfers to those that originated from the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "external_account_id", "required": false, "schema": { "description": "Filter FedNow Transfers to those made to the specified External Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_reviewing", "canceled", "reviewing_rejected", "requires_attention", "pending_approval", "pending_submitting", "pending_response", "complete", "rejected" ], "type": "string", "x-enum-descriptions": [ "The transfer is pending review by Increase.", "The transfer has been canceled.", "The transfer has been rejected by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is pending approval.", "The transfer is queued to be submitted to FedNow.", "The transfer has been submitted and is pending a response from FedNow.", "The transfer has been sent successfully and is complete.", "The transfer was rejected by the network or the recipient's bank." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fednow_transfer_list" } } }, "description": "FedNow Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List FedNow Transfers", "x-sandbox-only": false, "x-tag": "FedNow Transfers" }, "post": { "operationId": "create_a_fednow_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_fednow_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fednow_transfer" } } }, "description": "FedNow Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a FedNow Transfer", "x-sandbox-only": false, "x-tag": "FedNow Transfers" } }, "/fednow_transfers/{fednow_transfer_id}": { "get": { "operationId": "retrieve_a_fednow_transfer", "parameters": [ { "example": "fednow_transfer_4i0mptrdu1mueg1196bg", "in": "path", "name": "fednow_transfer_id", "required": true, "schema": { "description": "The identifier of the FedNow Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "FedNow Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fednow_transfer" } } }, "description": "FedNow Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a FedNow Transfer", "x-sandbox-only": false, "x-tag": "FedNow Transfers" } }, "/fednow_transfers/{fednow_transfer_id}/approve": { "post": { "operationId": "approve_a_fednow_transfer", "parameters": [ { "example": "fednow_transfer_4i0mptrdu1mueg1196bg", "in": "path", "name": "fednow_transfer_id", "required": true, "schema": { "description": "The identifier of the FedNow Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "FedNow Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fednow_transfer" } } }, "description": "FedNow Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve a FedNow Transfer", "x-sandbox-only": false, "x-tag": "FedNow Transfers" } }, "/fednow_transfers/{fednow_transfer_id}/cancel": { "post": { "operationId": "cancel_a_pending_fednow_transfer", "parameters": [ { "example": "fednow_transfer_4i0mptrdu1mueg1196bg", "in": "path", "name": "fednow_transfer_id", "required": true, "schema": { "description": "The identifier of the pending FedNow Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "FedNow Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fednow_transfer" } } }, "description": "FedNow Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending FedNow Transfer", "x-sandbox-only": false, "x-tag": "FedNow Transfers" } }, "/file_links": { "post": { "operationId": "create_a_file_link", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_file_link_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_link" } } }, "description": "File Link" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a File Link", "x-sandbox-only": false, "x-tag": "File Links" } }, "/files": { "get": { "operationId": "list_files", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "purpose.in", "required": false, "schema": { "description": "Filter Files for those with the specified purpose or purposes. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "card_dispute_attachment", "check_image_front", "check_image_back", "processed_check_image_front", "processed_check_image_back", "mailed_check_image", "check_attachment", "check_voucher_image", "check_signature", "inbound_mail_item", "form_1099_int", "form_1099_misc", "form_ss_4", "identity_document", "increase_statement", "loan_application_supplemental_document", "other", "trust_formation_document", "digital_wallet_artwork", "digital_wallet_app_icon", "physical_card_front", "physical_card_back", "physical_card_carrier", "document_request", "entity_supplemental_document", "export", "fee_statement", "unusual_activity_report_attachment", "deposit_account_control_agreement", "proof_of_authorization_request_submission", "account_verification_letter", "funding_instructions", "hold_harmless_letter" ], "type": "string", "x-enum-descriptions": [ "A file to be attached to a Card Dispute.", "An image of the front of a check, used for check deposits.", "An image of the back of a check, used for check deposits.", "An image of the front of a deposited check after processing by Increase and submission to the Federal Reserve.", "An image of the back of a deposited check after processing by Increase and submission to the Federal Reserve.", "An image of a check that was mailed to a recipient.", "A document to be printed on an additional page and mailed with a check that you've requested Increase print. This must be a PDF whose pages are all US letter size and all have the same orientation.", "An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.", "A signature image to be printed on a check. This must be a 1320x120 pixel PNG.", "A scanned mail item sent to Increase.", "IRS Form 1099-INT.", "IRS Form 1099-MISC.", "IRS Form SS-4.", "An image of a government-issued ID.", "A statement generated by Increase.", "A supplemental document for a Loan Application.", "A file purpose not covered by any of the other cases.", "A legal document forming a trust.", "A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.", "An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.", "A card image to be printed on the front of a physical card. This must be a 2100x1344 pixel PNG with no other color but black.", "The image to be printed on the back of a physical card.", "An image representing the entirety of the carrier used for a physical card. This must be a 2550x3300 pixel PNG with no other color but black.", "A document requested by Increase.", "A supplemental document associated an an Entity.", "The results of an Export you requested via the dashboard or API.", "A fee statement.", "An attachment to an Unusual Activity Report.", "A document granting another entity access to the funds into your account.", "A file containing additional evidence for a Proof of Authorization Request Submission.", "An account verification letter.", "Funding instructions.", "A Hold Harmless Letter." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file_list" } } }, "description": "File List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Files", "x-sandbox-only": false, "x-tag": "Files" }, "post": { "description": "To upload a file to Increase, you'll need to send a request of Content-Type `multipart/form-data`. The request should contain the file you would like to upload, as well as the parameters for creating a file.", "operationId": "create_a_file", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/create_a_file_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file" } } }, "description": "File" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a File", "x-sandbox-only": false, "x-tag": "Files" } }, "/files/{file_id}": { "get": { "operationId": "retrieve_a_file", "parameters": [ { "example": "file_makxrc67oh9l6sg7w9yc", "in": "path", "name": "file_id", "required": true, "schema": { "description": "The identifier of the File.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Files" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file" } } }, "description": "File" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a File", "x-sandbox-only": false, "x-tag": "Files" } }, "/groups/current": { "get": { "description": "Returns details for the currently authenticated Group.", "operationId": "retrieve_group_details", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group" } } }, "description": "Group" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve Group details", "x-sandbox-only": false, "x-tag": "Groups" } }, "/inbound_ach_transfers": { "get": { "operationId": "list_inbound_ach_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Inbound ACH Transfers to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "account_number_id", "required": false, "schema": { "description": "Filter Inbound ACH Transfers to ones belonging to the specified Account Number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Inbound ACH Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending", "declined", "accepted", "returned" ], "type": "string", "x-enum-descriptions": [ "The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken.", "The Inbound ACH Transfer has been declined.", "The Inbound ACH Transfer is accepted.", "The Inbound ACH Transfer has been returned." ] }, "type": "array", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_ach_transfer_list" } } }, "description": "Inbound ACH Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound ACH Transfers", "x-sandbox-only": false, "x-tag": "Inbound ACH Transfers" } }, "/inbound_ach_transfers/{inbound_ach_transfer_id}": { "get": { "operationId": "retrieve_an_inbound_ach_transfer", "parameters": [ { "example": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "in": "path", "name": "inbound_ach_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound ACH Transfer to get details for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_ach_transfer" } } }, "description": "Inbound ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound ACH Transfer", "x-sandbox-only": false, "x-tag": "Inbound ACH Transfers" } }, "/inbound_ach_transfers/{inbound_ach_transfer_id}/create_notification_of_change": { "post": { "operationId": "create_a_notification_of_change_for_an_inbound_ach_transfer", "parameters": [ { "example": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "in": "path", "name": "inbound_ach_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound ACH Transfer for which to create a notification of change.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_notification_of_change_for_an_inbound_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_ach_transfer" } } }, "description": "Inbound ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a notification of change for an Inbound ACH Transfer", "x-sandbox-only": false, "x-tag": "Inbound ACH Transfers" } }, "/inbound_ach_transfers/{inbound_ach_transfer_id}/decline": { "post": { "operationId": "decline_an_inbound_ach_transfer", "parameters": [ { "example": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "in": "path", "name": "inbound_ach_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound ACH Transfer to decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/decline_an_inbound_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_ach_transfer" } } }, "description": "Inbound ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Decline an Inbound ACH Transfer", "x-sandbox-only": false, "x-tag": "Inbound ACH Transfers" } }, "/inbound_ach_transfers/{inbound_ach_transfer_id}/transfer_return": { "post": { "operationId": "return_an_inbound_ach_transfer", "parameters": [ { "example": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "in": "path", "name": "inbound_ach_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound ACH Transfer to return to the originating financial institution.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound ACH Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/return_an_inbound_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_ach_transfer" } } }, "description": "Inbound ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Return an Inbound ACH Transfer", "x-sandbox-only": false, "x-tag": "Inbound ACH Transfers" } }, "/inbound_check_deposits": { "get": { "operationId": "list_inbound_check_deposits", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Inbound Check Deposits to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "check_transfer_id", "required": false, "schema": { "description": "Filter Inbound Check Deposits to those belonging to the specified Check Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_check_deposit_list" } } }, "description": "Inbound Check Deposit List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound Check Deposits", "x-sandbox-only": false, "x-tag": "Inbound Check Deposits" } }, "/inbound_check_deposits/{inbound_check_deposit_id}": { "get": { "operationId": "retrieve_an_inbound_check_deposit", "parameters": [ { "example": "inbound_check_deposit_zoshvqybq0cjjm31mra", "in": "path", "name": "inbound_check_deposit_id", "required": true, "schema": { "description": "The identifier of the Inbound Check Deposit to get details for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_check_deposit" } } }, "description": "Inbound Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound Check Deposit", "x-sandbox-only": false, "x-tag": "Inbound Check Deposits" } }, "/inbound_check_deposits/{inbound_check_deposit_id}/decline": { "post": { "operationId": "decline_an_inbound_check_deposit", "parameters": [ { "example": "inbound_check_deposit_zoshvqybq0cjjm31mra", "in": "path", "name": "inbound_check_deposit_id", "required": true, "schema": { "description": "The identifier of the Inbound Check Deposit to decline.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_check_deposit" } } }, "description": "Inbound Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Decline an Inbound Check Deposit", "x-sandbox-only": false, "x-tag": "Inbound Check Deposits" } }, "/inbound_check_deposits/{inbound_check_deposit_id}/return": { "post": { "operationId": "return_an_inbound_check_deposit", "parameters": [ { "example": "inbound_check_deposit_zoshvqybq0cjjm31mra", "in": "path", "name": "inbound_check_deposit_id", "required": true, "schema": { "description": "The identifier of the Inbound Check Deposit to return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/return_an_inbound_check_deposit_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_check_deposit" } } }, "description": "Inbound Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Return an Inbound Check Deposit", "x-sandbox-only": false, "x-tag": "Inbound Check Deposits" } }, "/inbound_fednow_transfers": { "get": { "operationId": "list_inbound_fednow_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Inbound FedNow Transfers to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "account_number_id", "required": false, "schema": { "description": "Filter Inbound FedNow Transfers to ones belonging to the specified Account Number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_fednow_transfer_list" } } }, "description": "Inbound FedNow Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound FedNow Transfers", "x-sandbox-only": false, "x-tag": "Inbound FedNow Transfers" } }, "/inbound_fednow_transfers/{inbound_fednow_transfer_id}": { "get": { "operationId": "retrieve_an_inbound_fednow_transfer", "parameters": [ { "example": "inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20", "in": "path", "name": "inbound_fednow_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound FedNow Transfer to get details for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound FedNow Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_fednow_transfer" } } }, "description": "Inbound FedNow Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound FedNow Transfer", "x-sandbox-only": false, "x-tag": "Inbound FedNow Transfers" } }, "/inbound_mail_items": { "get": { "operationId": "list_inbound_mail_items", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "lockbox_recipient_id", "required": false, "schema": { "description": "Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients" } }, { "in": "query", "name": "lockbox_address_id", "required": false, "schema": { "description": "Filter Inbound Mail Items to ones sent to the provided Lockbox Address.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_mail_item_list" } } }, "description": "Inbound Mail Item List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound Mail Items", "x-sandbox-only": false, "x-tag": "Inbound Mail Items" } }, "/inbound_mail_items/{inbound_mail_item_id}": { "get": { "operationId": "retrieve_an_inbound_mail_item", "parameters": [ { "example": "inbound_mail_item_q6rrg7mmqpplx80zceev", "in": "path", "name": "inbound_mail_item_id", "required": true, "schema": { "description": "The identifier of the Inbound Mail Item to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Mail Items" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_mail_item" } } }, "description": "Inbound Mail Item" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound Mail Item", "x-sandbox-only": false, "x-tag": "Inbound Mail Items" } }, "/inbound_mail_items/{inbound_mail_item_id}/action": { "post": { "operationId": "action_an_inbound_mail_item", "parameters": [ { "example": "inbound_mail_item_q6rrg7mmqpplx80zceev", "in": "path", "name": "inbound_mail_item_id", "required": true, "schema": { "description": "The identifier of the Inbound Mail Item to action.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Mail Items" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/action_an_inbound_mail_item_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_mail_item" } } }, "description": "Inbound Mail Item" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Action an Inbound Mail Item", "x-sandbox-only": false, "x-tag": "Inbound Mail Items" } }, "/inbound_real_time_payments_transfers": { "get": { "operationId": "list_inbound_real_time_payments_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Inbound Real-Time Payments Transfers to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "account_number_id", "required": false, "schema": { "description": "Filter Inbound Real-Time Payments Transfers to ones belonging to the specified Account Number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_real_time_payments_transfer_list" } } }, "description": "Inbound Real-Time Payments Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound Real-Time Payments Transfers", "x-sandbox-only": false, "x-tag": "Inbound Real-Time Payments Transfers" } }, "/inbound_real_time_payments_transfers/{inbound_real_time_payments_transfer_id}": { "get": { "operationId": "retrieve_an_inbound_real_time_payments_transfer", "parameters": [ { "example": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr", "in": "path", "name": "inbound_real_time_payments_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound Real-Time Payments Transfer to get details for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Real-Time Payments Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_real_time_payments_transfer" } } }, "description": "Inbound Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound Real-Time Payments Transfer", "x-sandbox-only": false, "x-tag": "Inbound Real-Time Payments Transfers" } }, "/inbound_wire_drawdown_requests": { "get": { "operationId": "list_inbound_wire_drawdown_requests", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_drawdown_request_list" } } }, "description": "Inbound Wire Drawdown Request List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound Wire Drawdown Requests", "x-sandbox-only": false, "x-tag": "Inbound Wire Drawdown Requests" } }, "/inbound_wire_drawdown_requests/{inbound_wire_drawdown_request_id}": { "get": { "operationId": "retrieve_an_inbound_wire_drawdown_request", "parameters": [ { "example": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e", "in": "path", "name": "inbound_wire_drawdown_request_id", "required": true, "schema": { "description": "The identifier of the Inbound Wire Drawdown Request to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Drawdown Requests" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_drawdown_request" } } }, "description": "Inbound Wire Drawdown Request" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound Wire Drawdown Request", "x-sandbox-only": false, "x-tag": "Inbound Wire Drawdown Requests" } }, "/inbound_wire_transfers": { "get": { "operationId": "list_inbound_wire_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Inbound Wire Transfers to ones belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "account_number_id", "required": false, "schema": { "description": "Filter Inbound Wire Transfers to ones belonging to the specified Account Number.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Account Numbers" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Inbound Wire Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending", "accepted", "declined", "reversed" ], "type": "string", "x-enum-descriptions": [ "The Inbound Wire Transfer is awaiting action, will transition automatically if no action is taken.", "The Inbound Wire Transfer is accepted.", "The Inbound Wire Transfer was declined.", "The Inbound Wire Transfer was reversed." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "wire_drawdown_request_id", "required": false, "schema": { "description": "Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown Request.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_transfer_list" } } }, "description": "Inbound Wire Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Inbound Wire Transfers", "x-sandbox-only": false, "x-tag": "Inbound Wire Transfers" } }, "/inbound_wire_transfers/{inbound_wire_transfer_id}": { "get": { "operationId": "retrieve_an_inbound_wire_transfer", "parameters": [ { "example": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "in": "path", "name": "inbound_wire_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound Wire Transfer to get details for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_transfer" } } }, "description": "Inbound Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an Inbound Wire Transfer", "x-sandbox-only": false, "x-tag": "Inbound Wire Transfers" } }, "/inbound_wire_transfers/{inbound_wire_transfer_id}/reverse": { "post": { "operationId": "reverse_an_inbound_wire_transfer", "parameters": [ { "example": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "in": "path", "name": "inbound_wire_transfer_id", "required": true, "schema": { "description": "The identifier of the Inbound Wire Transfer to reverse.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Wire Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reverse_an_inbound_wire_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_transfer" } } }, "description": "Inbound Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Reverse an Inbound Wire Transfer", "x-sandbox-only": false, "x-tag": "Inbound Wire Transfers" } }, "/intrafi_account_enrollments": { "get": { "operationId": "list_intrafi_account_enrollments", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter IntraFi Account Enrollments to the one belonging to an account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter IntraFi Account Enrollments for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_enrolling", "enrolled", "pending_unenrolling", "unenrolled", "requires_attention" ], "type": "string", "x-enum-descriptions": [ "The account is being added to the IntraFi network.", "The account has been enrolled with IntraFi.", "The account is being unenrolled from IntraFi's deposit sweep.", "The account was once enrolled, but is no longer enrolled at IntraFi.", "Something unexpected happened with this account. Contact Increase support." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_account_enrollment_list" } } }, "description": "IntraFi Account Enrollment List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List IntraFi Account Enrollments", "x-sandbox-only": false, "x-tag": "IntraFi Account Enrollments" }, "post": { "operationId": "enroll_an_account_in_the_intrafi_deposit_sweep_network", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enroll_an_account_in_the_intrafi_deposit_sweep_network_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_account_enrollment" } } }, "description": "IntraFi Account Enrollment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Enroll an account in the IntraFi deposit sweep network", "x-sandbox-only": false, "x-tag": "IntraFi Account Enrollments" } }, "/intrafi_account_enrollments/{intrafi_account_enrollment_id}": { "get": { "operationId": "get_an_intrafi_account_enrollment", "parameters": [ { "example": "intrafi_account_enrollment_w8l97znzreopkwf2tg75", "in": "path", "name": "intrafi_account_enrollment_id", "required": true, "schema": { "description": "The identifier of the IntraFi Account Enrollment to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "IntraFi Account Enrollments" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_account_enrollment" } } }, "description": "IntraFi Account Enrollment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Get an IntraFi Account Enrollment", "x-sandbox-only": false, "x-tag": "IntraFi Account Enrollments" } }, "/intrafi_account_enrollments/{intrafi_account_enrollment_id}/unenroll": { "post": { "operationId": "unenroll_an_account_from_intrafi", "parameters": [ { "example": "intrafi_account_enrollment_w8l97znzreopkwf2tg75", "in": "path", "name": "intrafi_account_enrollment_id", "required": true, "schema": { "description": "The Identifier of the IntraFi Account Enrollment to remove from IntraFi.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "IntraFi Account Enrollments" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_account_enrollment" } } }, "description": "IntraFi Account Enrollment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Unenroll an account from IntraFi", "x-sandbox-only": false, "x-tag": "IntraFi Account Enrollments" } }, "/intrafi_exclusions": { "get": { "operationId": "list_intrafi_exclusions", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "entity_n8y8tnk2p9339ti393yi", "in": "query", "name": "entity_id", "required": false, "schema": { "description": "Filter IntraFi Exclusions for those belonging to the specified Entity.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_exclusion_list" } } }, "description": "IntraFi Exclusion List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List IntraFi Exclusions", "x-sandbox-only": false, "x-tag": "IntraFi Exclusions" }, "post": { "operationId": "create_an_intrafi_exclusion", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_intrafi_exclusion_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_exclusion" } } }, "description": "IntraFi Exclusion" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an IntraFi Exclusion", "x-sandbox-only": false, "x-tag": "IntraFi Exclusions" } }, "/intrafi_exclusions/{intrafi_exclusion_id}": { "get": { "operationId": "get_an_intrafi_exclusion", "parameters": [ { "example": "account_in71c4amph0vgo2qllky", "in": "path", "name": "intrafi_exclusion_id", "required": true, "schema": { "description": "The identifier of the IntraFi Exclusion to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "IntraFi Exclusions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_exclusion" } } }, "description": "IntraFi Exclusion" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Get an IntraFi Exclusion", "x-sandbox-only": false, "x-tag": "IntraFi Exclusions" } }, "/intrafi_exclusions/{intrafi_exclusion_id}/archive": { "post": { "operationId": "archive_an_intrafi_exclusion", "parameters": [ { "example": "intrafi_exclusion_ygfqduuzpau3jqof6jyh", "in": "path", "name": "intrafi_exclusion_id", "required": true, "schema": { "description": "The identifier of the IntraFi Exclusion request to archive. It may take 5 business days for an exclusion removal to be processed. Removing an exclusion does not guarantee that funds will be swept to the previously-excluded bank.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "IntraFi Exclusions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intrafi_exclusion" } } }, "description": "IntraFi Exclusion" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Archive an IntraFi Exclusion", "x-sandbox-only": false, "x-tag": "IntraFi Exclusions" } }, "/lockbox_addresses": { "get": { "operationId": "list_lockbox_addresses", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_address_list" } } }, "description": "Lockbox Address List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Lockbox Addresses", "x-sandbox-only": false, "x-tag": "Lockbox Addresses" }, "post": { "operationId": "create_a_lockbox_address", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_lockbox_address_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_address" } } }, "description": "Lockbox Address" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Lockbox Address", "x-sandbox-only": false, "x-tag": "Lockbox Addresses" } }, "/lockbox_addresses/{lockbox_address_id}": { "get": { "operationId": "retrieve_a_lockbox_address", "parameters": [ { "example": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "in": "path", "name": "lockbox_address_id", "required": true, "schema": { "description": "The identifier of the Lockbox Address to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_address" } } }, "description": "Lockbox Address" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Lockbox Address", "x-sandbox-only": false, "x-tag": "Lockbox Addresses" }, "patch": { "operationId": "update_a_lockbox_address", "parameters": [ { "example": "lockbox_address_lw6sbzl9ol5dfd8hdml6", "in": "path", "name": "lockbox_address_id", "required": true, "schema": { "description": "The identifier of the Lockbox Address.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_a_lockbox_address_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_address" } } }, "description": "Lockbox Address" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update a Lockbox Address", "x-sandbox-only": false, "x-tag": "Lockbox Addresses" } }, "/lockbox_recipients": { "get": { "operationId": "list_lockbox_recipients", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Lockbox Recipients to those associated with the provided Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "lockbox_address_id", "required": false, "schema": { "description": "Filter Lockbox Recipients to those associated with the provided Lockbox Address.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Addresses" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_recipient_list" } } }, "description": "Lockbox Recipient List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Lockbox Recipients", "x-sandbox-only": false, "x-tag": "Lockbox Recipients" }, "post": { "operationId": "create_a_lockbox_recipient", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_lockbox_recipient_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_recipient" } } }, "description": "Lockbox Recipient" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Lockbox Recipient", "x-sandbox-only": false, "x-tag": "Lockbox Recipients" } }, "/lockbox_recipients/{lockbox_recipient_id}": { "get": { "operationId": "retrieve_a_lockbox_recipient", "parameters": [ { "example": "lockbox_3xt21ok13q19advds4t5", "in": "path", "name": "lockbox_recipient_id", "required": true, "schema": { "description": "The identifier of the Lockbox Recipient to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_recipient" } } }, "description": "Lockbox Recipient" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Lockbox Recipient", "x-sandbox-only": false, "x-tag": "Lockbox Recipients" }, "patch": { "operationId": "update_a_lockbox_recipient", "parameters": [ { "example": "lockbox_3xt21ok13q19advds4t5", "in": "path", "name": "lockbox_recipient_id", "required": true, "schema": { "description": "The identifier of the Lockbox Recipient.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Lockbox Recipients" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_a_lockbox_recipient_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockbox_recipient" } } }, "description": "Lockbox Recipient" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update a Lockbox Recipient", "x-sandbox-only": false, "x-tag": "Lockbox Recipients" } }, "/oauth/tokens": { "post": { "operationId": "create_an_oauth_token", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_an_oauth_token_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth_token" } } }, "description": "OAuth Token" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create an OAuth Token", "x-sandbox-only": false, "x-tag": "OAuth Tokens" } }, "/oauth_applications": { "get": { "operationId": "list_oauth_applications", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "deleted" ], "type": "string", "x-enum-descriptions": [ "The application is active and can be used by your users.", "The application is deleted." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth_application_list" } } }, "description": "OAuth Application List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List OAuth Applications", "x-sandbox-only": false, "x-tag": "OAuth Applications" } }, "/oauth_applications/{oauth_application_id}": { "get": { "operationId": "retrieve_an_oauth_application", "parameters": [ { "example": "application_gj9ufmpgh5i56k4vyriy", "in": "path", "name": "oauth_application_id", "required": true, "schema": { "description": "The identifier of the OAuth Application.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "OAuth Applications" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth_application" } } }, "description": "OAuth Application" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an OAuth Application", "x-sandbox-only": false, "x-tag": "OAuth Applications" } }, "/oauth_connections": { "get": { "operationId": "list_oauth_connections", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter to OAuth Connections by their status. By default, return only the `active` ones. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "active", "inactive" ], "type": "string", "x-enum-descriptions": [ "The OAuth connection is active.", "The OAuth connection is permanently deactivated." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "oauth_application_id", "required": false, "schema": { "description": "Filter results to only include OAuth Connections for a specific OAuth Application.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "OAuth Applications" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth_connection_list" } } }, "description": "OAuth Connection List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List OAuth Connections", "x-sandbox-only": false, "x-tag": "OAuth Connections" } }, "/oauth_connections/{oauth_connection_id}": { "get": { "operationId": "retrieve_an_oauth_connection", "parameters": [ { "example": "connection_dauknoksyr4wilz4e6my", "in": "path", "name": "oauth_connection_id", "required": true, "schema": { "description": "The identifier of the OAuth Connection.", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth_connection" } } }, "description": "OAuth Connection" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve an OAuth Connection", "x-sandbox-only": false, "x-tag": "OAuth Connections" } }, "/pending_transactions": { "get": { "operationId": "list_pending_transactions", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter pending transactions to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "route_id", "required": false, "schema": { "description": "Filter pending transactions to those belonging to the specified Route.", "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "category.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "account_transfer_instruction", "ach_transfer_instruction", "card_authorization", "check_deposit_instruction", "check_transfer_instruction", "fednow_transfer_instruction", "inbound_funds_hold", "user_initiated_hold", "real_time_payments_transfer_instruction", "wire_transfer_instruction", "inbound_wire_transfer_reversal", "swift_transfer_instruction", "card_push_transfer_instruction", "blockchain_onramp_transfer_instruction", "blockchain_offramp_transfer_instruction", "other" ], "type": "string", "x-enum-descriptions": [ "Account Transfer Instruction: details will be under the `account_transfer_instruction` object.", "ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.", "Card Authorization: details will be under the `card_authorization` object.", "Check Deposit Instruction: details will be under the `check_deposit_instruction` object.", "Check Transfer Instruction: details will be under the `check_transfer_instruction` object.", "FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.", "Inbound Funds Hold: details will be under the `inbound_funds_hold` object.", "User Initiated Hold: details will be under the `user_initiated_hold` object.", "Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.", "Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.", "Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.", "Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.", "Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.", "Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.", "Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.", "The Pending Transaction was made for an undocumented or deprecated reason." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status `pending` will be returned. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending", "complete" ], "type": "string", "x-enum-descriptions": [ "The Pending Transaction is still awaiting confirmation.", "The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pending_transaction_list" } } }, "description": "Pending Transaction List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Pending Transactions", "x-sandbox-only": false, "x-tag": "Pending Transactions" }, "post": { "description": "Creates a pending transaction on an account. This can be useful to hold funds for an external payment or known future transaction outside of Increase (only negative amounts are supported). The resulting Pending Transaction will have a `category` of `user_initiated_hold` and can be released via the API to unlock the held funds.", "operationId": "create_a_pending_transaction", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_pending_transaction_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pending_transaction" } } }, "description": "Pending Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Pending Transaction", "x-sandbox-only": false, "x-tag": "Pending Transactions" } }, "/pending_transactions/{pending_transaction_id}": { "get": { "operationId": "retrieve_a_pending_transaction", "parameters": [ { "example": "pending_transaction_k1sfetcau2qbvjbzgju4", "in": "path", "name": "pending_transaction_id", "required": true, "schema": { "description": "The identifier of the Pending Transaction.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pending_transaction" } } }, "description": "Pending Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Pending Transaction", "x-sandbox-only": false, "x-tag": "Pending Transactions" } }, "/pending_transactions/{pending_transaction_id}/release": { "post": { "description": "Release a Pending Transaction you had previously created. The Pending Transaction must have a `category` of `user_initiated_hold` and a `status` of `pending`. This will unlock the held funds and mark the Pending Transaction as complete.", "operationId": "release_a_user_initiated_pending_transaction", "parameters": [ { "example": "pending_transaction_k1sfetcau2qbvjbzgju4", "in": "path", "name": "pending_transaction_id", "required": true, "schema": { "description": "The identifier of the Pending Transaction to release.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pending_transaction" } } }, "description": "Pending Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Release a user-initiated Pending Transaction", "x-sandbox-only": false, "x-tag": "Pending Transactions" } }, "/physical_card_profiles": { "get": { "operationId": "list_physical_card_profiles", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Physical Card Profiles for those with the specified statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_creating", "pending_reviewing", "rejected", "pending_submitting", "active", "archived" ], "type": "string", "x-enum-descriptions": [ "The Card Profile has not yet been processed by Increase.", "The card profile is awaiting review by Increase.", "There is an issue with the Physical Card Profile preventing it from use.", "The card profile is awaiting submission to the fulfillment provider.", "The Physical Card Profile has been submitted to the fulfillment provider and is ready to use.", "The Physical Card Profile has been archived." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card_profile_list" } } }, "description": "Physical Card Profile List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Physical Card Profiles", "x-sandbox-only": false, "x-tag": "Physical Card Profiles" }, "post": { "operationId": "create_a_physical_card_profile", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_physical_card_profile_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card_profile" } } }, "description": "Physical Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Physical Card Profile", "x-sandbox-only": false, "x-tag": "Physical Card Profiles" } }, "/physical_card_profiles/{physical_card_profile_id}": { "get": { "operationId": "retrieve_a_card_profile", "parameters": [ { "example": "physical_card_profile_m534d5rn9qyy9ufqxoec", "in": "path", "name": "physical_card_profile_id", "required": true, "schema": { "description": "The identifier of the Card Profile.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Card Profiles" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card_profile" } } }, "description": "Physical Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Card Profile", "x-sandbox-only": false, "x-tag": "Physical Card Profiles" } }, "/physical_card_profiles/{physical_card_profile_id}/archive": { "post": { "operationId": "archive_a_physical_card_profile", "parameters": [ { "example": "physical_card_profile_m534d5rn9qyy9ufqxoec", "in": "path", "name": "physical_card_profile_id", "required": true, "schema": { "description": "The identifier of the Physical Card Profile to archive.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Card Profiles" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card_profile" } } }, "description": "Physical Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Archive a Physical Card Profile", "x-sandbox-only": false, "x-tag": "Physical Card Profiles" } }, "/physical_card_profiles/{physical_card_profile_id}/clone": { "post": { "operationId": "clone_a_physical_card_profile", "parameters": [ { "example": "physical_card_profile_m534d5rn9qyy9ufqxoec", "in": "path", "name": "physical_card_profile_id", "required": true, "schema": { "description": "The identifier of the Physical Card Profile to clone.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Card Profiles" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clone_a_physical_card_profile_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card_profile" } } }, "description": "Physical Card Profile" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Clone a Physical Card Profile", "x-sandbox-only": false, "x-tag": "Physical Card Profiles" } }, "/physical_cards": { "get": { "operationId": "list_physical_cards", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "card_oubs0hwk5rn6knuecxg2", "in": "query", "name": "card_id", "required": false, "schema": { "description": "Filter Physical Cards to ones belonging to the specified Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Cards" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card_list" } } }, "description": "Physical Card List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Physical Cards", "x-sandbox-only": false, "x-tag": "Physical Cards" }, "post": { "operationId": "create_a_physical_card", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_physical_card_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card" } } }, "description": "Physical Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Physical Card", "x-sandbox-only": false, "x-tag": "Physical Cards" } }, "/physical_cards/{physical_card_id}": { "get": { "operationId": "retrieve_a_physical_card", "parameters": [ { "example": "physical_card_ode8duyq5v2ynhjoharl", "in": "path", "name": "physical_card_id", "required": true, "schema": { "description": "The identifier of the Physical Card.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card" } } }, "description": "Physical Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Physical Card", "x-sandbox-only": false, "x-tag": "Physical Cards" }, "patch": { "operationId": "update_a_physical_card", "parameters": [ { "example": "physical_card_ode8duyq5v2ynhjoharl", "in": "path", "name": "physical_card_id", "required": true, "schema": { "description": "The Physical Card identifier.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_a_physical_card_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card" } } }, "description": "Physical Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Update a Physical Card", "x-sandbox-only": false, "x-tag": "Physical Cards" } }, "/programs": { "get": { "operationId": "list_programs", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/program_list" } } }, "description": "Program List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Programs", "x-sandbox-only": false, "x-tag": "Programs" } }, "/programs/{program_id}": { "get": { "operationId": "retrieve_a_program", "parameters": [ { "example": "program_i2v2os4mwza1oetokh9i", "in": "path", "name": "program_id", "required": true, "schema": { "description": "The identifier of the Program to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Programs" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/program" } } }, "description": "Program" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Program", "x-sandbox-only": false, "x-tag": "Programs" } }, "/real_time_decisions/{real_time_decision_id}": { "get": { "operationId": "retrieve_a_real_time_decision", "parameters": [ { "example": "real_time_decision_j76n2e810ezcg3zh5qtn", "in": "path", "name": "real_time_decision_id", "required": true, "schema": { "description": "The identifier of the Real-Time Decision.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_decision" } } }, "description": "Real-Time Decision" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Real-Time Decision", "x-sandbox-only": false, "x-tag": "Real-Time Decisions" } }, "/real_time_decisions/{real_time_decision_id}/action": { "post": { "operationId": "action_a_real_time_decision", "parameters": [ { "example": "real_time_decision_j76n2e810ezcg3zh5qtn", "in": "path", "name": "real_time_decision_id", "required": true, "schema": { "description": "The identifier of the Real-Time Decision.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Decisions" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/action_a_real_time_decision_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_decision" } } }, "description": "Real-Time Decision" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Action a Real-Time Decision", "x-sandbox-only": false, "x-tag": "Real-Time Decisions" } }, "/real_time_payments_transfers": { "get": { "operationId": "list_real_time_payments_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Real-Time Payments Transfers to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "external_account_id", "required": false, "schema": { "description": "Filter Real-Time Payments Transfers to those made to the specified External Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_approval", "canceled", "pending_reviewing", "requires_attention", "rejected", "pending_submission", "submitted", "complete" ], "type": "string", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer was rejected by the network or the recipient's bank.", "The transfer is queued to be submitted to Real-Time Payments.", "The transfer has been submitted and is pending a response from Real-Time Payments.", "The transfer has been sent successfully and is complete." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_payments_transfer_list" } } }, "description": "Real-Time Payments Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Real-Time Payments Transfers", "x-sandbox-only": false, "x-tag": "Real-Time Payments Transfers" }, "post": { "operationId": "create_a_real_time_payments_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_real_time_payments_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_payments_transfer" } } }, "description": "Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Real-Time Payments Transfer", "x-sandbox-only": false, "x-tag": "Real-Time Payments Transfers" } }, "/real_time_payments_transfers/{real_time_payments_transfer_id}": { "get": { "operationId": "retrieve_a_real_time_payments_transfer", "parameters": [ { "example": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "in": "path", "name": "real_time_payments_transfer_id", "required": true, "schema": { "description": "The identifier of the Real-Time Payments Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_payments_transfer" } } }, "description": "Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Real-Time Payments Transfer", "x-sandbox-only": false, "x-tag": "Real-Time Payments Transfers" } }, "/real_time_payments_transfers/{real_time_payments_transfer_id}/approve": { "post": { "description": "Approves a Real-Time Payments Transfer in a pending_approval state.", "operationId": "approve_a_real_time_payments_transfer", "parameters": [ { "example": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "in": "path", "name": "real_time_payments_transfer_id", "required": true, "schema": { "description": "The identifier of the Real-Time Payments Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_payments_transfer" } } }, "description": "Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve a Real-Time Payments Transfer", "x-sandbox-only": false, "x-tag": "Real-Time Payments Transfers" } }, "/real_time_payments_transfers/{real_time_payments_transfer_id}/cancel": { "post": { "description": "Cancels a Real-Time Payments Transfer in a pending_approval state.", "operationId": "cancel_a_pending_real_time_payments_transfer", "parameters": [ { "example": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "in": "path", "name": "real_time_payments_transfer_id", "required": true, "schema": { "description": "The identifier of the pending Real-Time Payments Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_payments_transfer" } } }, "description": "Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending Real-Time Payments Transfer", "x-sandbox-only": false, "x-tag": "Real-Time Payments Transfers" } }, "/routing_numbers": { "get": { "description": "You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.", "operationId": "list_routing_numbers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "021000021", "in": "query", "name": "routing_number", "required": true, "schema": { "description": "Filter financial institutions by routing number.", "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routing_number_list" } } }, "description": "Routing Number List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Routing Numbers", "x-sandbox-only": false, "x-tag": "Routing Numbers" } }, "/simulations/account_revenue_payments": { "post": { "description": "Simulates an account revenue payment to your account. In production, this happens automatically on the first of each month.", "operationId": "sandbox_create_an_account_revenue_payment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_account_revenue_payment_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transaction" } } }, "description": "Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an account revenue payment", "x-returns-example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "Revenue Payment for My first account! in 2025-06", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "account_revenue_payment": { "accrued_on_account_id": "account_in71c4amph0vgo2qllky", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00" }, "category": "account_revenue_payment" }, "type": "transaction" }, "x-sandbox-only": true, "x-tag": "Accounts" } }, "/simulations/account_statements": { "post": { "description": "Simulates an [Account Statement](#account-statements) being created for an account. In production, Account Statements are generated once per month.", "operationId": "sandbox_create_an_account_statement", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_account_statement_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_statement" } } }, "description": "Account Statement" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Account Statement", "x-sandbox-only": true, "x-tag": "Account Statements" } }, "/simulations/ach_transfers/{ach_transfer_id}/acknowledge": { "post": { "description": "Simulates the acknowledgement of an [ACH Transfer](#ach-transfers) by the Federal Reserve. This transfer must first have a `status` of `submitted`. In production, the Federal Reserve generally acknowledges submitted ACH files within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and add the acknowledgement subresource to the ACH Transfer.", "operationId": "sandbox_acknowledge_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer you wish to become acknowledged.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Acknowledge an ACH Transfer", "x-sandbox-only": true, "x-tag": "ACH Transfers" } }, "/simulations/ach_transfers/{ach_transfer_id}/create_notification_of_change": { "post": { "description": "Simulates receiving a Notification of Change for an [ACH Transfer](#ach-transfers).", "operationId": "sandbox_create_a_notification_of_change_for_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer you wish to create a notification of change for.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_notification_of_change_for_an_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Notification of Change for an ACH Transfer", "x-sandbox-only": true, "x-tag": "ACH Transfers" } }, "/simulations/ach_transfers/{ach_transfer_id}/return": { "post": { "description": "Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve due to an error condition. This will also create a Transaction to account for the returned funds. This transfer must first have a `status` of `submitted`.", "operationId": "sandbox_return_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer you wish to return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_return_an_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Return an ACH Transfer", "x-sandbox-only": true, "x-tag": "ACH Transfers" } }, "/simulations/ach_transfers/{ach_transfer_id}/settle": { "post": { "description": "Simulates the settlement of an [ACH Transfer](#ach-transfers) by the Federal Reserve. This transfer must first have a `status` of `pending_submission` or `submitted`. For convenience, if the transfer is in `status`: `pending_submission`, the simulation will also submit the transfer. Without this simulation the transfer will eventually settle on its own following the same Federal Reserve timeline as in production. Additionally, you can specify the behavior of the inbound funds hold that is created when the ACH Transfer is settled. If no behavior is specified, the inbound funds hold will be released immediately in order for the funds to be available for use.", "operationId": "sandbox_settle_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer you wish to become settled.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_settle_an_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Settle an ACH Transfer", "x-sandbox-only": true, "x-tag": "ACH Transfers" } }, "/simulations/ach_transfers/{ach_transfer_id}/submit": { "post": { "description": "Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_submission`. In production, Increase submits ACH Transfers to the Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and transition the ACH Transfer to a status of `submitted`.", "operationId": "sandbox_submit_an_ach_transfer", "parameters": [ { "example": "ach_transfer_uoxatyh3lt5evrsdvo7q", "in": "path", "name": "ach_transfer_id", "required": true, "schema": { "description": "The identifier of the ACH Transfer you wish to submit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "ACH Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ach_transfer" } } }, "description": "ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Submit an ACH Transfer", "x-sandbox-only": true, "x-tag": "ACH Transfers" } }, "/simulations/card_authentications": { "post": { "description": "Simulates a Card Authentication attempt on a [Card](#cards). The attempt always results in a [Card Payment](#card_payments) being created, either with a status that allows further action or a terminal failed status.", "operationId": "sandbox_create_a_card_authentication_attempt", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_card_authentication_attempt_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Card Authentication attempt", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_authentications/{card_payment_id}/challenge_attempts": { "post": { "description": "Simulates an attempt at a Card Authentication Challenge. This updates the `card_authentications` object under the [Card Payment](#card_payments). You can also attempt the challenge by navigating to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.", "operationId": "sandbox_create_a_card_authentication_challenge_attempt", "parameters": [ { "example": "card_payment_nd3k2kacrqjli8482ave", "in": "path", "name": "card_payment_id", "required": true, "schema": { "description": "The identifier of the Card Payment to be challenged.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_card_authentication_challenge_attempt_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Card Authentication Challenge attempt", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_authentications/{card_payment_id}/challenges": { "post": { "description": "Simulates starting a Card Authentication Challenge for an existing Card Authentication. This updates the `card_authentications` object under the [Card Payment](#card_payments). To attempt the challenge, use the `/simulations/card_authentications/:card_payment_id/challenge_attempts` endpoint or navigate to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.", "operationId": "sandbox_create_an_initial_card_authentication_challenge", "parameters": [ { "example": "card_payment_nd3k2kacrqjli8482ave", "in": "path", "name": "card_payment_id", "required": true, "schema": { "description": "The identifier of the Card Payment to be challenged.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Payments" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an initial Card Authentication Challenge", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_authorization_expirations": { "post": { "description": "Simulates expiring a Card Authorization immediately.", "operationId": "sandbox_expire_a_card_authorization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_expire_a_card_authorization_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Expire a Card Authorization", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_authorizations": { "post": { "description": "Simulates a purchase authorization on a [Card](#cards). Depending on the balance available to the card and the `amount` submitted, the authorization activity will result in a [Pending Transaction](#pending-transactions) of type `card_authorization` or a [Declined Transaction](#declined-transactions) of type `card_decline`. You can pass either a Card id or a [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different ways purchases can be made.", "operationId": "sandbox_create_a_card_authorization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_card_authorization_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_card_authorization_simulation_result" } } }, "description": "Inbound Card Authorization Simulation Result" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Card Authorization", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_balance_inquiries": { "post": { "description": "Simulates a balance inquiry on a [Card](#cards).", "operationId": "sandbox_create_a_card_balance_inquiry", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_card_balance_inquiry_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Card Balance Inquiry", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_disputes/{card_dispute_id}/action": { "post": { "description": "After a [Card Dispute](#card-disputes) is created in production, the dispute will initially be in a `pending_user_submission_reviewing` state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states.", "operationId": "sandbox_advance_the_state_of_a_card_dispute", "parameters": [ { "example": "card_dispute_h9sc95nbl1cgltpp7men", "in": "path", "name": "card_dispute_id", "required": true, "schema": { "description": "The dispute you would like to action.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Card Disputes" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_advance_the_state_of_a_card_dispute_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_dispute" } } }, "description": "Card Dispute" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Advance the state of a Card Dispute", "x-sandbox-only": true, "x-tag": "Card Disputes" } }, "/simulations/card_fuel_confirmations": { "post": { "description": "Simulates the fuel confirmation of an authorization by a card acquirer. This happens asynchronously right after a fuel pump transaction is completed. A fuel confirmation can only happen once per authorization.", "operationId": "sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Confirm the fuel pump amount for a Card Authorization", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_increments": { "post": { "description": "Simulates the increment of an authorization by a card acquirer. An authorization can be incremented multiple times.", "operationId": "sandbox_increment_a_card_authorization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_increment_a_card_authorization_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Increment a Card Authorization", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_purchase_supplements": { "post": { "description": "Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card settlement. This happens asynchronously in production when Visa sends enhanced transaction data about a purchase.", "operationId": "sandbox_create_a_card_purchase_supplement", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_card_purchase_supplement_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_purchase_supplement" } } }, "description": "Card Purchase Supplement" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Card Purchase Supplement", "x-sandbox-only": true, "x-tag": "Card Purchase Supplements" } }, "/simulations/card_refunds": { "post": { "description": "Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.", "operationId": "sandbox_refund_a_card_transaction", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_refund_a_card_transaction_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transaction" } } }, "description": "Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Refund a card transaction", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_reversals": { "post": { "description": "Simulates the reversal of an authorization by a card acquirer. An authorization can be partially reversed multiple times, up until the total authorized amount. Marks the pending transaction as complete if the authorization is fully reversed.", "operationId": "sandbox_reverse_a_card_authorization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_reverse_a_card_authorization_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_payment" } } }, "description": "Card Payment" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Reverse a Card Authorization", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_settlements": { "post": { "description": "Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill.", "operationId": "sandbox_settle_a_card_authorization", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_settle_a_card_authorization_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transaction" } } }, "description": "Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Settle a Card Authorization", "x-sandbox-only": true, "x-tag": "Card Payments" } }, "/simulations/card_tokens": { "post": { "description": "Simulates tokenizing a card in the sandbox environment.", "operationId": "sandbox_create_a_card_token", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_card_token_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/card_token" } } }, "description": "Card Token" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Card Token", "x-sandbox-only": true, "x-tag": "Card Tokens" } }, "/simulations/check_deposits/{check_deposit_id}/adjustment": { "post": { "description": "Simulates the creation of a [Check Deposit Adjustment](#check-deposit-adjustments) on a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`.", "operationId": "sandbox_adjust_a_check_deposit", "parameters": [ { "example": "check_deposit_f06n9gpg7sxn8t19lfc1", "in": "path", "name": "check_deposit_id", "required": true, "schema": { "description": "The identifier of the Check Deposit you wish to adjust.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_adjust_a_check_deposit_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit" } } }, "description": "Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Adjust a Check Deposit", "x-sandbox-only": true, "x-tag": "Check Deposits" } }, "/simulations/check_deposits/{check_deposit_id}/reject": { "post": { "description": "Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to factors like poor image quality. This Check Deposit must first have a `status` of `pending`.", "operationId": "sandbox_reject_a_check_deposit", "parameters": [ { "example": "check_deposit_f06n9gpg7sxn8t19lfc1", "in": "path", "name": "check_deposit_id", "required": true, "schema": { "description": "The identifier of the Check Deposit you wish to reject.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit" } } }, "description": "Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Reject a Check Deposit", "x-sandbox-only": true, "x-tag": "Check Deposits" } }, "/simulations/check_deposits/{check_deposit_id}/return": { "post": { "description": "Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`.", "operationId": "sandbox_return_a_check_deposit", "parameters": [ { "example": "check_deposit_f06n9gpg7sxn8t19lfc1", "in": "path", "name": "check_deposit_id", "required": true, "schema": { "description": "The identifier of the Check Deposit you wish to return.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit" } } }, "description": "Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Return a Check Deposit", "x-sandbox-only": true, "x-tag": "Check Deposits" } }, "/simulations/check_deposits/{check_deposit_id}/submit": { "post": { "description": "Simulates the submission of a [Check Deposit](#check-deposits) to the Federal Reserve. This Check Deposit must first have a `status` of `pending`.", "operationId": "sandbox_submit_a_check_deposit", "parameters": [ { "example": "check_deposit_f06n9gpg7sxn8t19lfc1", "in": "path", "name": "check_deposit_id", "required": true, "schema": { "description": "The identifier of the Check Deposit you wish to submit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Deposits" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_submit_a_check_deposit_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_deposit" } } }, "description": "Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Submit a Check Deposit", "x-sandbox-only": true, "x-tag": "Check Deposits" } }, "/simulations/check_transfers/{check_transfer_id}/mail": { "post": { "description": "Simulates the mailing of a [Check Transfer](#check-transfers), which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a `status` of `pending_approval` or `pending_submission`.", "operationId": "sandbox_mail_a_check_transfer", "parameters": [ { "example": "check_transfer_30b43acfu9vw8fyc4f5", "in": "path", "name": "check_transfer_id", "required": true, "schema": { "description": "The identifier of the Check Transfer you wish to mail.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Check Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/check_transfer" } } }, "description": "Check Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Mail a Check Transfer", "x-sandbox-only": true, "x-tag": "Check Transfers" } }, "/simulations/digital_wallet_token_requests": { "post": { "description": "Simulates a user attempting to add a [Card](#cards) to a digital wallet such as Apple Pay.", "operationId": "sandbox_create_a_digital_wallet_token_request", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_digital_wallet_token_request_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_digital_wallet_token_request_simulation_result" } } }, "description": "Inbound Digital Wallet Token Request Simulation Result" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a digital wallet token request", "x-sandbox-only": true, "x-tag": "Digital Wallet Tokens" } }, "/simulations/entities/{entity_id}/validation": { "post": { "description": "Set the status for an [Entity's validation](/documentation/api/entities#entity-object.validation). In production, Know Your Customer validations [run automatically](/documentation/entity-validation#entity-validation). While developing, it can be helpful to override the behavior in Sandbox.", "operationId": "sandbox_simulate_the_status_for_an_entitys_validation", "parameters": [ { "example": "entity_n8y8tnk2p9339ti393yi", "in": "path", "name": "entity_id", "required": true, "schema": { "description": "The identifier of the Entity whose validation status to update.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entities" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_simulate_the_status_for_an_entitys_validation_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity" } } }, "description": "Entity" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Simulate the status for an Entity's validation", "x-sandbox-only": true, "x-tag": "Entities" } }, "/simulations/entity_onboarding_sessions/{entity_onboarding_session_id}/submit": { "post": { "description": "Simulates the submission of an [Entity Onboarding Session](#entity-onboarding-sessions). This session must have a `status` of `active`. After submission, the session will transition to `expired` and a new Entity will be created.", "operationId": "sandbox_submit_an_entity_onboarding_session", "parameters": [ { "example": "entity_onboarding_session_wid2ug11fsmvh3k9hymd", "in": "path", "name": "entity_onboarding_session_id", "required": true, "schema": { "description": "The identifier of the Entity Onboarding Session you wish to submit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Entity Onboarding Sessions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/entity_onboarding_session" } } }, "description": "Entity Onboarding Session" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Submit an Entity Onboarding Session", "x-sandbox-only": true, "x-tag": "Entity Onboarding Sessions" } }, "/simulations/exports": { "post": { "description": "Many exports are created by you via POST /exports or in the Dashboard. Some exports are created automatically by Increase. For example, tax documents are published once a year. In sandbox, you can trigger the arrival of an export that would normally only be created automatically via this simulation.", "operationId": "sandbox_generate_a_tax_form_export", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_generate_a_tax_form_export_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export" } } }, "description": "Export" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Generate a Tax Form Export", "x-sandbox-only": true, "x-tag": "Exports" } }, "/simulations/inbound_ach_transfers": { "post": { "description": "Simulates an inbound ACH transfer to your account. This imitates initiating a transfer to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the `amount` is positive or negative. The result of calling this API will contain the created transfer. You can pass a `resolve_at` parameter to allow for a window to [action on the Inbound ACH Transfer](https://increase.com/documentation/receiving-ach-transfers). Alternatively, if you don't pass the `resolve_at` parameter the result will contain either a [Transaction](#transactions) or a [Declined Transaction](#declined-transactions) depending on whether or not the transfer is allowed.", "operationId": "sandbox_create_an_inbound_ach_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_ach_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_ach_transfer" } } }, "description": "Inbound ACH Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound ACH Transfer", "x-sandbox-only": true, "x-tag": "Inbound ACH Transfers" } }, "/simulations/inbound_check_deposits": { "post": { "description": "Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.", "operationId": "sandbox_create_an_inbound_check_deposit", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_check_deposit_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_check_deposit" } } }, "description": "Inbound Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound Check Deposit", "x-sandbox-only": true, "x-tag": "Inbound Check Deposits" } }, "/simulations/inbound_check_deposits/{inbound_check_deposit_id}/adjustment": { "post": { "description": "Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit must have a `status` of `accepted`.", "operationId": "sandbox_create_an_inbound_check_deposit_adjustment", "parameters": [ { "example": "inbound_check_deposit_zoshvqybq0cjjm31mra", "in": "path", "name": "inbound_check_deposit_id", "required": true, "schema": { "description": "The identifier of the Inbound Check Deposit to adjust.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Inbound Check Deposits" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_check_deposit_adjustment_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_check_deposit" } } }, "description": "Inbound Check Deposit" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound Check Deposit Adjustment", "x-sandbox-only": true, "x-tag": "Inbound Check Deposits" } }, "/simulations/inbound_fednow_transfers": { "post": { "description": "Simulates an [Inbound FedNow Transfer](#inbound-fednow-transfers) to your account.", "operationId": "sandbox_create_an_inbound_fednow_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_fednow_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_fednow_transfer" } } }, "description": "Inbound FedNow Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound FedNow Transfer", "x-sandbox-only": true, "x-tag": "Inbound FedNow Transfers" } }, "/simulations/inbound_mail_items": { "post": { "description": "Simulates an inbound mail item to your account, as if someone had mailed a physical check to one of your account's Lockboxes.", "operationId": "sandbox_create_an_inbound_mail_item", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_mail_item_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_mail_item" } } }, "description": "Inbound Mail Item" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound Mail Item", "x-sandbox-only": true, "x-tag": "Inbound Mail Items" } }, "/simulations/inbound_real_time_payments_transfers": { "post": { "description": "Simulates an [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to your account. Real-Time Payments are a beta feature.", "operationId": "sandbox_create_an_inbound_real_time_payments_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_real_time_payments_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_real_time_payments_transfer" } } }, "description": "Inbound Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound Real-Time Payments Transfer", "x-sandbox-only": true, "x-tag": "Inbound Real-Time Payments Transfers" } }, "/simulations/inbound_wire_drawdown_requests": { "post": { "description": "Simulates receiving an [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).", "operationId": "sandbox_create_an_inbound_wire_drawdown_request", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_wire_drawdown_request_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_drawdown_request" } } }, "description": "Inbound Wire Drawdown Request" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound Wire Drawdown request", "x-sandbox-only": true, "x-tag": "Inbound Wire Drawdown Requests" } }, "/simulations/inbound_wire_transfers": { "post": { "description": "Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.", "operationId": "sandbox_create_an_inbound_wire_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_inbound_wire_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_wire_transfer" } } }, "description": "Inbound Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an Inbound Wire Transfer", "x-sandbox-only": true, "x-tag": "Inbound Wire Transfers" } }, "/simulations/interest_payments": { "post": { "description": "Simulates an interest payment to your account. In production, this happens automatically on the first of each month.", "operationId": "sandbox_create_an_interest_payment", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_an_interest_payment_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transaction" } } }, "description": "Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create an interest payment", "x-returns-example": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "Interest payment for 2025-06", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "category": "interest_payment", "interest_payment": { "accrued_on_account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "currency": "USD", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00" } }, "type": "transaction" }, "x-sandbox-only": true, "x-tag": "Accounts" } }, "/simulations/pending_transactions/{pending_transaction_id}/release_inbound_funds_hold": { "post": { "description": "This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of, for example, an ACH debit.", "operationId": "sandbox_release_an_inbound_funds_hold", "parameters": [ { "example": "pending_transaction_k1sfetcau2qbvjbzgju4", "in": "path", "name": "pending_transaction_id", "required": true, "schema": { "description": "The pending transaction to release. The pending transaction must have a `inbound_funds_hold` source.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Pending Transactions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pending_transaction" } } }, "description": "Pending Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Release an Inbound Funds Hold", "x-sandbox-only": true, "x-tag": "Pending Transactions" } }, "/simulations/physical_cards/{physical_card_id}/advance_shipment": { "post": { "description": "This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery.", "operationId": "sandbox_advance_the_shipment_status_of_a_physical_card", "parameters": [ { "example": "physical_card_ode8duyq5v2ynhjoharl", "in": "path", "name": "physical_card_id", "required": true, "schema": { "description": "The Physical Card you would like to action.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_advance_the_shipment_status_of_a_physical_card_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card" } } }, "description": "Physical Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Advance the shipment status of a Physical Card", "x-sandbox-only": true, "x-tag": "Physical Cards" } }, "/simulations/physical_cards/{physical_card_id}/tracking_updates": { "post": { "description": "This endpoint allows you to simulate receiving a tracking update for a Physical Card, to simulate the progress of a shipment.", "operationId": "sandbox_create_a_physical_card_shipment_tracking_update", "parameters": [ { "example": "physical_card_ode8duyq5v2ynhjoharl", "in": "path", "name": "physical_card_id", "required": true, "schema": { "description": "The Physical Card you would like to action.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Physical Cards" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_physical_card_shipment_tracking_update_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/physical_card" } } }, "description": "Physical Card" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Physical Card Shipment Tracking Update", "x-sandbox-only": true, "x-tag": "Physical Cards" } }, "/simulations/programs": { "post": { "description": "Simulates a [Program](#programs) being created in your group. By default, your group has one program called Commercial Banking. Note that when your group operates more than one program, `program_id` is a required field when creating accounts.", "operationId": "sandbox_create_a_program", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_create_a_program_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/program" } } }, "description": "Program" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Create a Program", "x-sandbox-only": true, "x-tag": "Programs" } }, "/simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete": { "post": { "description": "Simulates submission of a [Real-Time Payments Transfer](#real-time-payments-transfers) and handling the response from the destination financial institution. This transfer must first have a `status` of `pending_submission`.", "operationId": "sandbox_complete_a_real_time_payments_transfer", "parameters": [ { "example": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "in": "path", "name": "real_time_payments_transfer_id", "required": true, "schema": { "description": "The identifier of the Real-Time Payments Transfer you wish to complete.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Real-Time Payments Transfers" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sandbox_complete_a_real_time_payments_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/real_time_payments_transfer" } } }, "description": "Real-Time Payments Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Complete a Real-Time Payments Transfer", "x-sandbox-only": true, "x-tag": "Real-Time Payments Transfers" } }, "/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse": { "post": { "description": "Simulates a Wire Drawdown Request being refused by the debtor.", "operationId": "sandbox_refuse_a_wire_drawdown_request", "parameters": [ { "example": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "in": "path", "name": "wire_drawdown_request_id", "required": true, "schema": { "description": "The identifier of the Wire Drawdown Request you wish to refuse.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_drawdown_request" } } }, "description": "Wire Drawdown Request" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Refuse a Wire Drawdown Request", "x-sandbox-only": true, "x-tag": "Wire Drawdown Requests" } }, "/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/submit": { "post": { "description": "Simulates a Wire Drawdown Request being submitted to Fedwire.", "operationId": "sandbox_submit_a_wire_drawdown_request", "parameters": [ { "example": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "in": "path", "name": "wire_drawdown_request_id", "required": true, "schema": { "description": "The identifier of the Wire Drawdown Request you wish to submit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_drawdown_request" } } }, "description": "Wire Drawdown Request" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Submit a Wire Drawdown Request", "x-sandbox-only": true, "x-tag": "Wire Drawdown Requests" } }, "/simulations/wire_transfers/{wire_transfer_id}/reverse": { "post": { "description": "Simulates the reversal of a [Wire Transfer](#wire-transfers) by the Federal Reserve due to error conditions. This will also create a [Transaction](#transaction) to account for the returned funds. This Wire Transfer must first have a `status` of `complete`.", "operationId": "sandbox_reverse_a_wire_transfer", "parameters": [ { "example": "wire_transfer_5akynk7dqsq25qwk9q2u", "in": "path", "name": "wire_transfer_id", "required": true, "schema": { "description": "The identifier of the Wire Transfer you wish to reverse.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer" } } }, "description": "Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Reverse a Wire Transfer", "x-sandbox-only": true, "x-tag": "Wire Transfers" } }, "/simulations/wire_transfers/{wire_transfer_id}/submit": { "post": { "description": "Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_creating`.", "operationId": "sandbox_submit_a_wire_transfer", "parameters": [ { "example": "wire_transfer_5akynk7dqsq25qwk9q2u", "in": "path", "name": "wire_transfer_id", "required": true, "schema": { "description": "The identifier of the Wire Transfer you wish to submit.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer" } } }, "description": "Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Sandbox: Submit a Wire Transfer", "x-sandbox-only": true, "x-tag": "Wire Transfers" } }, "/swift_transfers": { "get": { "operationId": "list_swift_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Swift Transfers to those that originated from the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_approval", "canceled", "pending_reviewing", "requires_attention", "pending_initiating", "initiated", "rejected", "returned" ], "type": "string", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is pending initiation.", "The transfer has been initiated.", "The transfer has been rejected by Increase.", "The transfer has been returned." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swift_transfer_list" } } }, "description": "Swift Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Swift Transfers", "x-sandbox-only": false, "x-tag": "Swift Transfers" }, "post": { "operationId": "create_a_swift_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_swift_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swift_transfer" } } }, "description": "Swift Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Swift Transfer", "x-sandbox-only": false, "x-tag": "Swift Transfers" } }, "/swift_transfers/{swift_transfer_id}": { "get": { "operationId": "retrieve_a_swift_transfer", "parameters": [ { "example": "swift_transfer_29h21xkng03788zwd3fh", "in": "path", "name": "swift_transfer_id", "required": true, "schema": { "description": "The identifier of the Swift Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swift_transfer" } } }, "description": "Swift Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Swift Transfer", "x-sandbox-only": false, "x-tag": "Swift Transfers" } }, "/swift_transfers/{swift_transfer_id}/approve": { "post": { "operationId": "approve_a_swift_transfer", "parameters": [ { "example": "swift_transfer_29h21xkng03788zwd3fh", "in": "path", "name": "swift_transfer_id", "required": true, "schema": { "description": "The identifier of the Swift Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swift_transfer" } } }, "description": "Swift Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve a Swift Transfer", "x-sandbox-only": false, "x-tag": "Swift Transfers" } }, "/swift_transfers/{swift_transfer_id}/cancel": { "post": { "operationId": "cancel_a_pending_swift_transfer", "parameters": [ { "example": "swift_transfer_29h21xkng03788zwd3fh", "in": "path", "name": "swift_transfer_id", "required": true, "schema": { "description": "The identifier of the pending Swift Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Swift Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swift_transfer" } } }, "description": "Swift Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending Swift Transfer", "x-sandbox-only": false, "x-tag": "Swift Transfers" } }, "/transactions": { "get": { "operationId": "list_transactions", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Transactions for those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "category.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "account_transfer_intention", "ach_transfer_intention", "ach_transfer_rejection", "ach_transfer_return", "cashback_payment", "card_dispute_acceptance", "card_dispute_financial", "card_dispute_loss", "card_refund", "card_settlement", "card_financial", "card_revenue_payment", "check_deposit_acceptance", "check_deposit_return", "fednow_transfer_acknowledgement", "check_transfer_deposit", "fee_payment", "inbound_ach_transfer", "inbound_ach_transfer_return_intention", "inbound_check_deposit_return_intention", "inbound_check_adjustment", "inbound_fednow_transfer_confirmation", "inbound_real_time_payments_transfer_confirmation", "inbound_wire_reversal", "inbound_wire_transfer", "inbound_wire_transfer_reversal", "interest_payment", "internal_source", "real_time_payments_transfer_acknowledgement", "sample_funds", "wire_transfer_intention", "swift_transfer_intention", "swift_transfer_return", "card_push_transfer_acceptance", "account_revenue_payment", "blockchain_onramp_transfer_intention", "blockchain_offramp_transfer_settlement", "other" ], "type": "string", "x-enum-descriptions": [ "Account Transfer Intention: details will be under the `account_transfer_intention` object.", "ACH Transfer Intention: details will be under the `ach_transfer_intention` object.", "ACH Transfer Rejection: details will be under the `ach_transfer_rejection` object.", "ACH Transfer Return: details will be under the `ach_transfer_return` object.", "Cashback Payment: details will be under the `cashback_payment` object.", "Legacy Card Dispute Acceptance: details will be under the `card_dispute_acceptance` object.", "Card Dispute Financial: details will be under the `card_dispute_financial` object.", "Legacy Card Dispute Loss: details will be under the `card_dispute_loss` object.", "Card Refund: details will be under the `card_refund` object.", "Card Settlement: details will be under the `card_settlement` object.", "Card Financial: details will be under the `card_financial` object.", "Card Revenue Payment: details will be under the `card_revenue_payment` object.", "Check Deposit Acceptance: details will be under the `check_deposit_acceptance` object.", "Check Deposit Return: details will be under the `check_deposit_return` object.", "FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.", "Check Transfer Deposit: details will be under the `check_transfer_deposit` object.", "Fee Payment: details will be under the `fee_payment` object.", "Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` object.", "Inbound ACH Transfer Return Intention: details will be under the `inbound_ach_transfer_return_intention` object.", "Inbound Check Deposit Return Intention: details will be under the `inbound_check_deposit_return_intention` object.", "Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.", "Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.", "Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.", "Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object.", "Inbound Wire Transfer Intention: details will be under the `inbound_wire_transfer` object.", "Inbound Wire Transfer Reversal Intention: details will be under the `inbound_wire_transfer_reversal` object.", "Interest Payment: details will be under the `interest_payment` object.", "Internal Source: details will be under the `internal_source` object.", "Real-Time Payments Transfer Acknowledgement: details will be under the `real_time_payments_transfer_acknowledgement` object.", "Sample Funds: details will be under the `sample_funds` object.", "Wire Transfer Intention: details will be under the `wire_transfer_intention` object.", "Swift Transfer Intention: details will be under the `swift_transfer_intention` object.", "Swift Transfer Return: details will be under the `swift_transfer_return` object.", "Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.", "Account Revenue Payment: details will be under the `account_revenue_payment` object.", "Blockchain On-Ramp Transfer Intention: details will be under the `blockchain_onramp_transfer_intention` object.", "Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.", "The Transaction was made for an undocumented or deprecated reason." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "route_id", "required": false, "schema": { "description": "Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID.", "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transaction_list" } } }, "description": "Transaction List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Transactions", "x-sandbox-only": false, "x-tag": "Transactions" } }, "/transactions/{transaction_id}": { "get": { "operationId": "retrieve_a_transaction", "parameters": [ { "example": "transaction_uyrp7fld2ium70oa7oi", "in": "path", "name": "transaction_id", "required": true, "schema": { "description": "The identifier of the Transaction to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Transactions" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transaction" } } }, "description": "Transaction" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Transaction", "x-sandbox-only": false, "x-tag": "Transactions" } }, "/wire_drawdown_requests": { "get": { "operationId": "list_wire_drawdown_requests", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Filter Wire Drawdown Requests for those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_submission", "fulfilled", "pending_response", "refused" ], "type": "string", "x-enum-descriptions": [ "The drawdown request is queued to be submitted to Fedwire.", "The drawdown request has been fulfilled by the recipient.", "The drawdown request has been sent and the recipient should respond in some way.", "The drawdown request has been refused by the recipient." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_drawdown_request_list" } } }, "description": "Wire Drawdown Request List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Wire Drawdown Requests", "x-sandbox-only": false, "x-tag": "Wire Drawdown Requests" }, "post": { "operationId": "create_a_wire_drawdown_request", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_wire_drawdown_request_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_drawdown_request" } } }, "description": "Wire Drawdown Request" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Wire Drawdown Request", "x-sandbox-only": false, "x-tag": "Wire Drawdown Requests" } }, "/wire_drawdown_requests/{wire_drawdown_request_id}": { "get": { "operationId": "retrieve_a_wire_drawdown_request", "parameters": [ { "example": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "in": "path", "name": "wire_drawdown_request_id", "required": true, "schema": { "description": "The identifier of the Wire Drawdown Request to retrieve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Drawdown Requests" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_drawdown_request" } } }, "description": "Wire Drawdown Request" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Wire Drawdown Request", "x-sandbox-only": false, "x-tag": "Wire Drawdown Requests" } }, "/wire_transfers": { "get": { "operationId": "list_wire_transfers", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Return the page of entries after this one.", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects.", "minimum": 1, "type": "integer", "x-documentation-priority": "low" } }, { "example": "account_in71c4amph0vgo2qllky", "in": "query", "name": "account_id", "required": false, "schema": { "description": "Filter Wire Transfers to those belonging to the specified Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Accounts" } }, { "in": "query", "name": "external_account_id", "required": false, "schema": { "description": "Filter Wire Transfers to those made to the specified External Account.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "External Accounts" } }, { "in": "query", "name": "idempotency_key", "required": false, "schema": { "description": "Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).", "maxLength": 200, "minLength": 1, "type": "string", "x-documentation-priority": "default" } }, { "in": "query", "name": "status.in", "required": false, "schema": { "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.", "items": { "enum": [ "pending_approval", "canceled", "pending_reviewing", "rejected", "requires_attention", "pending_creating", "reversed", "submitted", "complete" ], "type": "string", "x-enum-descriptions": [ "The transfer is pending approval.", "The transfer has been canceled.", "The transfer is pending review by Increase.", "The transfer has been rejected by Increase.", "The transfer requires attention from an Increase operator.", "The transfer is pending creation.", "The transfer has been reversed.", "The transfer has been submitted to Fedwire.", "The transfer has been acknowledged by Fedwire and can be considered complete." ] }, "type": "array", "x-documentation-priority": "default" } }, { "in": "query", "name": "created_at.after", "required": false, "schema": { "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.before", "required": false, "schema": { "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_after", "required": false, "schema": { "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } }, { "in": "query", "name": "created_at.on_or_before", "required": false, "schema": { "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.", "format": "date-time", "type": "string", "x-documentation-priority": "low" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer_list" } } }, "description": "Wire Transfer List" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "List Wire Transfers", "x-sandbox-only": false, "x-tag": "Wire Transfers" }, "post": { "operationId": "create_a_wire_transfer", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_a_wire_transfer_parameters" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer" } } }, "description": "Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Create a Wire Transfer", "x-sandbox-only": false, "x-tag": "Wire Transfers" } }, "/wire_transfers/{wire_transfer_id}": { "get": { "operationId": "retrieve_a_wire_transfer", "parameters": [ { "example": "wire_transfer_5akynk7dqsq25qwk9q2u", "in": "path", "name": "wire_transfer_id", "required": true, "schema": { "description": "The identifier of the Wire Transfer.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer" } } }, "description": "Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Retrieve a Wire Transfer", "x-sandbox-only": false, "x-tag": "Wire Transfers" } }, "/wire_transfers/{wire_transfer_id}/approve": { "post": { "operationId": "approve_a_wire_transfer", "parameters": [ { "example": "wire_transfer_5akynk7dqsq25qwk9q2u", "in": "path", "name": "wire_transfer_id", "required": true, "schema": { "description": "The identifier of the Wire Transfer to approve.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer" } } }, "description": "Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Approve a Wire Transfer", "x-sandbox-only": false, "x-tag": "Wire Transfers" } }, "/wire_transfers/{wire_transfer_id}/cancel": { "post": { "operationId": "cancel_a_pending_wire_transfer", "parameters": [ { "example": "wire_transfer_5akynk7dqsq25qwk9q2u", "in": "path", "name": "wire_transfer_id", "required": true, "schema": { "description": "The identifier of the pending Wire Transfer to cancel.", "type": "string", "x-documentation-priority": "default", "x-id-reference-to": "Wire Transfers" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wire_transfer" } } }, "description": "Wire Transfer" }, "4XX": { "$ref": "#/components/responses/errorResponse" }, "5XX": { "$ref": "#/components/responses/errorResponse" } }, "summary": "Cancel a pending Wire Transfer", "x-sandbox-only": false, "x-tag": "Wire Transfers" } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://api.increase.com" }, { "url": "https://sandbox.increase.com" } ], "tags": [ { "description": "Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.", "name": "Accounts" }, { "description": "Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.", "name": "Account Numbers" }, { "description": "Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).", "name": "Account Transfers" }, { "description": "Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.", "name": "Cards" }, { "description": "Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.", "name": "Card Payments" }, { "description": "Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.", "name": "Card Purchase Supplements" }, { "description": "If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.", "name": "Card Disputes" }, { "description": "Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile](/documentation/api#card-profiles). The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact [support@increase.com](mailto:support@increase.com) for pricing!", "name": "Physical Cards" }, { "description": "This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on [digital card artwork](https://increase.com/documentation/card-art).", "name": "Digital Card Profiles" }, { "description": "This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on [physical card artwork](https://increase.com/documentation/card-art-physical-cards).", "name": "Physical Card Profiles" }, { "description": "A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.", "name": "Digital Wallet Tokens" }, { "description": "Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).", "name": "Transactions" }, { "description": "Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).", "name": "Pending Transactions" }, { "description": "Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.", "name": "Declined Transactions" }, { "description": "ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).", "name": "ACH Transfers" }, { "description": "An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.", "name": "Inbound ACH Transfers" }, { "description": "ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).", "name": "ACH Prenotifications" }, { "description": "Wire transfers move funds between your Increase account and any other account accessible by Fedwire.", "name": "Wire Transfers" }, { "description": "An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.", "name": "Inbound Wire Transfers" }, { "description": "Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to [support@increase.com](mailto:support@increase.com) to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).", "name": "Wire Drawdown Requests" }, { "description": "Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).", "name": "Inbound Wire Drawdown Requests" }, { "description": "Check Transfers move funds from your Increase account by mailing a physical check.", "name": "Check Transfers" }, { "description": "Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.", "name": "Inbound Check Deposits" }, { "description": "Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.", "name": "Real-Time Payments Transfers" }, { "description": "An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.", "name": "Inbound Real-Time Payments Transfers" }, { "description": "FedNow transfers move funds, within seconds, between your Increase account and any other account supporting FedNow.", "name": "FedNow Transfers" }, { "description": "An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.", "name": "Inbound FedNow Transfers" }, { "description": "Swift Transfers send funds internationally.", "name": "Swift Transfers" }, { "description": "Check Deposits allow you to deposit images of paper checks into your account.", "name": "Check Deposits" }, { "description": "Lockbox Addresses are physical locations that can receive mail containing paper checks.", "name": "Lockbox Addresses" }, { "description": "Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.", "name": "Lockbox Recipients" }, { "description": "Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.", "name": "Inbound Mail Items" }, { "description": "Routing numbers are used to identify your bank in a financial transaction.", "name": "Routing Numbers" }, { "description": "External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.", "name": "External Accounts" }, { "description": "Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities).", "name": "Entities" }, { "description": "Beneficial owners are the individuals who control or own 25% or more of a `corporation` entity. Beneficial owners are always people, and never organizations. Generally, you will need to submit between 1 and 5 beneficial owners for every `corporation` entity. You should update and archive beneficial owners for a corporation entity as their details change.", "name": "Beneficial Owners" }, { "description": "Supplemental Documents are uploaded files connected to an Entity during onboarding.", "name": "Supplemental Documents" }, { "description": "Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're done, they'll be redirected back to your site. This API is used for [hosted onboarding](/documentation/hosted-onboarding).", "name": "Entity Onboarding Sessions" }, { "description": "Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.", "name": "Programs" }, { "description": "Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.", "name": "Account Statements" }, { "description": "Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.", "name": "Files" }, { "description": "File Links let you generate a URL that can be used to download a File.", "name": "File Links" }, { "description": "Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports).", "name": "Exports" }, { "description": "Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).", "name": "Events" }, { "description": "Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).", "name": "Event Subscriptions" }, { "description": "Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our [Real-Time Decisions guide](https://increase.com/documentation/real-time-decisions).", "name": "Real-Time Decisions" }, { "description": "Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth [here](https://increase.com/documentation/oauth).", "name": "Groups" }, { "description": "An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth [here](https://increase.com/documentation/oauth).", "name": "OAuth Applications" }, { "description": "When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth [here](https://increase.com/documentation/oauth).", "name": "OAuth Connections" }, { "description": "A token that is returned to your application when a user completes the OAuth flow and may be used to authenticate requests. Learn more about OAuth [here](/documentation/oauth).", "name": "OAuth Tokens" }, { "description": "IntraFi is a [network of financial institutions](https://www.intrafi.com/network-banks) that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.", "name": "IntraFi Account Enrollments" }, { "description": "When using IntraFi, each account's balance over the standard FDIC insurance amount is swept to various other institutions. Funds are rebalanced across banks as needed once per business day.", "name": "IntraFi Balances" }, { "description": "Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.", "name": "IntraFi Exclusions" }, { "description": "Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.", "name": "Card Tokens" }, { "description": "Card Push Transfers send funds to a recipient's payment card in real-time.", "name": "Card Push Transfers" }, { "description": "Card Validations are used to validate a card and its cardholder before sending funds to or pulling funds from a card.", "name": "Card Validations" } ], "x-tagGroups": [ { "name": "Accounts", "tags": [ "Accounts", "Account Numbers", "Account Transfers" ] }, { "name": "Transactions", "tags": [ "Transactions", "Pending Transactions", "Declined Transactions" ] }, { "name": "Ach Transfers", "tags": [ "ACH Transfers", "Inbound ACH Transfers", "ACH Prenotifications" ] }, { "name": "Check Transfers", "tags": [ "Check Transfers", "Inbound Check Deposits" ] }, { "name": "Real Time Payments Transfers", "tags": [ "Real-Time Payments Transfers", "Inbound Real-Time Payments Transfers" ] }, { "name": "Fednow Transfers", "tags": [ "FedNow Transfers", "Inbound FedNow Transfers" ] }, { "name": "Swift Transfers", "tags": [ "Swift Transfers" ] }, { "name": "Wire Transfers", "tags": [ "Wire Transfers", "Inbound Wire Transfers", "Wire Drawdown Requests", "Inbound Wire Drawdown Requests" ] }, { "name": "Card Transfers", "tags": [ "Card Tokens", "Card Push Transfers", "Card Validations" ] }, { "name": "Check Deposits", "tags": [ "Check Deposits", "Lockbox Addresses", "Lockbox Recipients", "Inbound Mail Items" ] }, { "name": "Cards", "tags": [ "Cards", "Card Payments", "Card Purchase Supplements", "Card Disputes", "Physical Cards", "Digital Card Profiles", "Physical Card Profiles", "Digital Wallet Tokens" ] }, { "name": "Compliance", "tags": [ "Entities", "Beneficial Owners", "Supplemental Documents", "Entity Onboarding Sessions", "Programs" ] }, { "name": "Events and Webhooks", "tags": [ "Events", "Event Subscriptions", "Real-Time Decisions" ] }, { "name": "External Accounts", "tags": [ "Routing Numbers", "External Accounts" ] }, { "name": "Files and Exports", "tags": [ "Account Statements", "Files", "File Links", "Exports" ] }, { "name": "OAuth", "tags": [ "Groups", "OAuth Applications", "OAuth Connections", "OAuth Tokens" ] }, { "name": "Intrafi", "tags": [ "IntraFi Account Enrollments", "IntraFi Balances", "IntraFi Exclusions" ] } ] }