{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml","oas-api/index.yaml":"oas-api/index.yaml"},"props":{"metadata":{"markdoc":{"tagList":["inline-svg","tabs","tab","openapi-code-sample","code-snippet","admonition","json-schema"]},"type":"markdown"},"seo":{"title":"Me to Me Payouts","description":"Move funds between a customer's own accounts using Finix Me to Me payouts. Pull from a card or bank account and push to a debit or credit card.","siteUrl":"https://docs.finix.com/","llmstxt":{"hide":false,"sections":[{"title":"Getting Started","includeFiles":["guides/getting-started/**/*.md"],"excludeFiles":[]},{"title":"Online Payments","includeFiles":["guides/online-payments/**/*.md"],"excludeFiles":["guides/online-payments/payment-features/fsa-hsa-non-healthcare-mcc.md"]},{"title":"In-Person Payments","includeFiles":["guides/in-person-payments/**/*.md"],"excludeFiles":[]},{"title":"Subscriptions","includeFiles":["guides/subscriptions/**/*.md"],"excludeFiles":[]},{"title":"After the Payment","includeFiles":["guides/subscriptions/after-the-payment/**/*.md"],"excludeFiles":[]},{"title":"Managing Operations","includeFiles":["guides/managing-operations/**/*.md"],"excludeFiles":[]},{"title":"Platform Payments","includeFiles":["guides/platform-payments/**/*.md"],"excludeFiles":[]},{"title":"Payouts","includeFiles":["guides/payouts/**/*.md"],"excludeFiles":[]},{"title":"Developers","includeFiles":["additional-resources/developers/**/*.md"],"excludeFiles":[]},{"title":"Plugins","includeFiles":["additional-resources/plugins/**/*.md"],"excludeFiles":[]},{"title":"Industry Considerations","includeFiles":["guides/industry-considerations/**/*.md"],"excludeFiles":[]},{"title":"Regional Considerations","includeFiles":["guides/regional-considerations/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]},"image":"/images/og-images/guides-payouts-me-to-me-payouts.png"},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"me-to-me-payouts","__idx":0},"children":["Me to Me Payouts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Me to Me payouts allow you to move funds between a customer's own payment instruments — pulling from a card or bank account and pushing to a bank account, debit card or credit card."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The flow consists of two ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Transfer"]}," operations:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pull Transfer"]}," that pulls funds from the customer's source card (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PULL_FROM_CARD"]},") or bank account (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PULL_FROM_ACH"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PULL_FROM_SAME_DAY_ACH"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payout transfer"]}," that pushes funds to the customer's destination card (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUSH_TO_CARD"]},") or bank account (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUSH_TO_ACH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUSH_TO_SAME_DAY_ACH"]},"), linked to the completed pull transfer via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pull_transfer_id"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both transfers must use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["funds_flow_type: ME_TO_ME"]}," and be associated with the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identity"]},". The pull and payout transfer must be for the same amount."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have any questions about Me to Me payouts, reach out to your Finix Point of Contact or ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"mailto:support@finix.com"},"children":["Finix Support"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-an-identity","__idx":1},"children":["Step 1: Create an Identity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The first step is creating an ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api/identities/createidentity"},"children":["Identity ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["with Sender & Recipient roles"]}]}," to represent the customer. The Identity resource helps manage payment instruments, payout history, and customer details. You can create either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PERSONAL"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS"]}," Identities."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-data","__idx":2},"children":["Required Data"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"33%","align":"center","data-label":"Required"},"children":["Required "," "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"33%","align":"center","data-label":"Optional"},"children":["Optional "," "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"33%","align":"center","data-label":"Invalid"},"children":["Invalid "," "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/optional.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 2.375c-2.93 0-5.586 1.563-7.07 4.063-1.446 2.539-1.446 5.625 0 8.125A8.134 8.134 0 0011 18.625c2.89 0 5.547-1.523 7.031-4.063 1.446-2.5 1.446-5.585 0-8.124-1.484-2.5-4.14-4.063-7.031-4.063zM11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836l-5 5c-.39.39-.976.39-1.328 0l-2.5-2.5a.856.856 0 010-1.289c.351-.39.937-.39 1.328 0l1.836 1.836 4.336-4.336c.351-.39.937-.39 1.328 0a.92.92 0 010 1.29z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/invalid.svg","fileRawContent":"<svg width=\"22\" height=\"21\" viewBox=\"0 0 22 21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5C7.40625 20.5 4.125 18.625 2.32812 15.5C0.53125 12.4141 0.53125 8.625 2.32812 5.5C4.125 2.41406 7.40625 0.5 11 0.5C14.5547 0.5 17.8359 2.41406 19.6328 5.5C21.4297 8.625 21.4297 12.4141 19.6328 15.5C17.8359 18.625 14.5547 20.5 11 20.5ZM7.83594 7.33594C7.44531 7.72656 7.44531 8.3125 7.83594 8.66406L9.67188 10.5L7.83594 12.3359C7.44531 12.7266 7.44531 13.3125 7.83594 13.6641C8.1875 14.0547 8.77344 14.0547 9.125 13.6641L10.9609 11.8281L12.7969 13.6641C13.1875 14.0547 13.7734 14.0547 14.125 13.6641C14.5156 13.3125 14.5156 12.7266 14.125 12.3359L12.2891 10.5L14.125 8.66406C14.5156 8.3125 14.5156 7.72656 14.125 7.33594C13.7734 6.98438 13.1875 6.98438 12.7969 7.33594L10.9609 9.17188L9.125 7.33594C8.77344 6.98438 8.1875 6.98438 7.83594 7.33594Z\" fill=\"#E31725\"/></svg>"},"children":[]}," "]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"30%","data-label":"Field"},"children":["Field "]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"type: PERSONAL"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: PERSONAL"]}," "]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"type: BUSINESS"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: BUSINESS"]}," "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identity Roles ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identity_roles"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First Name ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["first_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last Name ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["last_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Personal Address ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personal_address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business Name ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["business_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/invalid.svg","fileRawContent":"<svg width=\"22\" height=\"21\" viewBox=\"0 0 22 21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5C7.40625 20.5 4.125 18.625 2.32812 15.5C0.53125 12.4141 0.53125 8.625 2.32812 5.5C4.125 2.41406 7.40625 0.5 11 0.5C14.5547 0.5 17.8359 2.41406 19.6328 5.5C21.4297 8.625 21.4297 12.4141 19.6328 15.5C17.8359 18.625 14.5547 20.5 11 20.5ZM7.83594 7.33594C7.44531 7.72656 7.44531 8.3125 7.83594 8.66406L9.67188 10.5L7.83594 12.3359C7.44531 12.7266 7.44531 13.3125 7.83594 13.6641C8.1875 14.0547 8.77344 14.0547 9.125 13.6641L10.9609 11.8281L12.7969 13.6641C13.1875 14.0547 13.7734 14.0547 14.125 13.6641C14.5156 13.3125 14.5156 12.7266 14.125 12.3359L12.2891 10.5L14.125 8.66406C14.5156 8.3125 14.5156 7.72656 14.125 7.33594C13.7734 6.98438 13.1875 6.98438 12.7969 7.33594L10.9609 9.17188L9.125 7.33594C8.77344 6.98438 8.1875 6.98438 7.83594 7.33594Z\" fill=\"#E31725\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Doing Business As ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["doing_business_as"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/invalid.svg","fileRawContent":"<svg width=\"22\" height=\"21\" viewBox=\"0 0 22 21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5C7.40625 20.5 4.125 18.625 2.32812 15.5C0.53125 12.4141 0.53125 8.625 2.32812 5.5C4.125 2.41406 7.40625 0.5 11 0.5C14.5547 0.5 17.8359 2.41406 19.6328 5.5C21.4297 8.625 21.4297 12.4141 19.6328 15.5C17.8359 18.625 14.5547 20.5 11 20.5ZM7.83594 7.33594C7.44531 7.72656 7.44531 8.3125 7.83594 8.66406L9.67188 10.5L7.83594 12.3359C7.44531 12.7266 7.44531 13.3125 7.83594 13.6641C8.1875 14.0547 8.77344 14.0547 9.125 13.6641L10.9609 11.8281L12.7969 13.6641C13.1875 14.0547 13.7734 14.0547 14.125 13.6641C14.5156 13.3125 14.5156 12.7266 14.125 12.3359L12.2891 10.5L14.125 8.66406C14.5156 8.3125 14.5156 7.72656 14.125 7.33594C13.7734 6.98438 13.1875 6.98438 12.7969 7.33594L10.9609 9.17188L9.125 7.33594C8.77344 6.98438 8.1875 6.98438 7.83594 7.33594Z\" fill=\"#E31725\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business Address ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["business_address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/invalid.svg","fileRawContent":"<svg width=\"22\" height=\"21\" viewBox=\"0 0 22 21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5C7.40625 20.5 4.125 18.625 2.32812 15.5C0.53125 12.4141 0.53125 8.625 2.32812 5.5C4.125 2.41406 7.40625 0.5 11 0.5C14.5547 0.5 17.8359 2.41406 19.6328 5.5C21.4297 8.625 21.4297 12.4141 19.6328 15.5C17.8359 18.625 14.5547 20.5 11 20.5ZM7.83594 7.33594C7.44531 7.72656 7.44531 8.3125 7.83594 8.66406L9.67188 10.5L7.83594 12.3359C7.44531 12.7266 7.44531 13.3125 7.83594 13.6641C8.1875 14.0547 8.77344 14.0547 9.125 13.6641L10.9609 11.8281L12.7969 13.6641C13.1875 14.0547 13.7734 14.0547 14.125 13.6641C14.5156 13.3125 14.5156 12.7266 14.125 12.3359L12.2891 10.5L14.125 8.66406C14.5156 8.3125 14.5156 7.72656 14.125 7.33594C13.7734 6.98438 13.1875 6.98438 12.7969 7.33594L10.9609 9.17188L9.125 7.33594C8.77344 6.98438 8.1875 6.98438 7.83594 7.33594Z\" fill=\"#E31725\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/required.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836h-.039c.39-.351.39-.937 0-1.328a.92.92 0 00-1.29 0L9.75 11.71 7.914 9.875c-.39-.39-.976-.39-1.328 0a.856.856 0 000 1.29l2.5 2.5c.351.39.937.39 1.328 0l5-5z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business Phone ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["business_phone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/invalid.svg","fileRawContent":"<svg width=\"22\" height=\"21\" viewBox=\"0 0 22 21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 20.5C7.40625 20.5 4.125 18.625 2.32812 15.5C0.53125 12.4141 0.53125 8.625 2.32812 5.5C4.125 2.41406 7.40625 0.5 11 0.5C14.5547 0.5 17.8359 2.41406 19.6328 5.5C21.4297 8.625 21.4297 12.4141 19.6328 15.5C17.8359 18.625 14.5547 20.5 11 20.5ZM7.83594 7.33594C7.44531 7.72656 7.44531 8.3125 7.83594 8.66406L9.67188 10.5L7.83594 12.3359C7.44531 12.7266 7.44531 13.3125 7.83594 13.6641C8.1875 14.0547 8.77344 14.0547 9.125 13.6641L10.9609 11.8281L12.7969 13.6641C13.1875 14.0547 13.7734 14.0547 14.125 13.6641C14.5156 13.3125 14.5156 12.7266 14.125 12.3359L12.2891 10.5L14.125 8.66406C14.5156 8.3125 14.5156 7.72656 14.125 7.33594C13.7734 6.98438 13.1875 6.98438 12.7969 7.33594L10.9609 9.17188L9.125 7.33594C8.77344 6.98438 8.1875 6.98438 7.83594 7.33594Z\" fill=\"#E31725\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/optional.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 2.375c-2.93 0-5.586 1.563-7.07 4.063-1.446 2.539-1.446 5.625 0 8.125A8.134 8.134 0 0011 18.625c2.89 0 5.547-1.523 7.031-4.063 1.446-2.5 1.446-5.585 0-8.124-1.484-2.5-4.14-4.063-7.031-4.063zM11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836l-5 5c-.39.39-.976.39-1.328 0l-2.5-2.5a.856.856 0 010-1.289c.351-.39.937-.39 1.328 0l1.836 1.836 4.336-4.336c.351-.39.937-.39 1.328 0a.92.92 0 010 1.29z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Personal Email ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/optional.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 2.375c-2.93 0-5.586 1.563-7.07 4.063-1.446 2.539-1.446 5.625 0 8.125A8.134 8.134 0 0011 18.625c2.89 0 5.547-1.523 7.031-4.063 1.446-2.5 1.446-5.585 0-8.124-1.484-2.5-4.14-4.063-7.031-4.063zM11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836l-5 5c-.39.39-.976.39-1.328 0l-2.5-2.5a.856.856 0 010-1.289c.351-.39.937-.39 1.328 0l1.836 1.836 4.336-4.336c.351-.39.937-.39 1.328 0a.92.92 0 010 1.29z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/optional.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 2.375c-2.93 0-5.586 1.563-7.07 4.063-1.446 2.539-1.446 5.625 0 8.125A8.134 8.134 0 0011 18.625c2.89 0 5.547-1.523 7.031-4.063 1.446-2.5 1.446-5.585 0-8.124-1.484-2.5-4.14-4.063-7.031-4.063zM11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836l-5 5c-.39.39-.976.39-1.328 0l-2.5-2.5a.856.856 0 010-1.289c.351-.39.937-.39 1.328 0l1.836 1.836 4.336-4.336c.351-.39.937-.39 1.328 0a.92.92 0 010 1.29z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Personal Phone ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/optional.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 2.375c-2.93 0-5.586 1.563-7.07 4.063-1.446 2.539-1.446 5.625 0 8.125A8.134 8.134 0 0011 18.625c2.89 0 5.547-1.523 7.031-4.063 1.446-2.5 1.446-5.585 0-8.124-1.484-2.5-4.14-4.063-7.031-4.063zM11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836l-5 5c-.39.39-.976.39-1.328 0l-2.5-2.5a.856.856 0 010-1.289c.351-.39.937-.39 1.328 0l1.836 1.836 4.336-4.336c.351-.39.937-.39 1.328 0a.92.92 0 010 1.29z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"InlineSvg","attributes":{"file":"/images/icons/optional.svg","fileRawContent":"<svg width=\"22\" height=\"21\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M11 2.375c-2.93 0-5.586 1.563-7.07 4.063-1.446 2.539-1.446 5.625 0 8.125A8.134 8.134 0 0011 18.625c2.89 0 5.547-1.523 7.031-4.063 1.446-2.5 1.446-5.585 0-8.124-1.484-2.5-4.14-4.063-7.031-4.063zM11 20.5c-3.594 0-6.875-1.875-8.672-5-1.797-3.086-1.797-6.875 0-10C4.125 2.414 7.406.5 11 .5c3.555 0 6.836 1.914 8.633 5 1.797 3.125 1.797 6.914 0 10a9.926 9.926 0 01-8.633 5zm4.414-11.836l-5 5c-.39.39-.976.39-1.328 0l-2.5-2.5a.856.856 0 010-1.289c.351-.39.937-.39 1.328 0l1.836 1.836 4.336-4.336c.351-.39.937-.39 1.328 0a.92.92 0 010 1.29z\" fill=\"#2E822A\"/></svg>"},"children":[]}," "]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-request","__idx":3},"children":["API Request"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Personal","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createIdentity","exampleKey":"Sender & Recipient (Personal)","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/identities/responses/json/createIdentitySenderAndRecipientPersonal.jsonc","language":"json","title":"Sender & Recipient (Personal)","header":{"title":"Sender & Recipient (Personal)","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"IDdRDX7H6hNcm4HexJBeZVUV\",\n  \"created_at\": \"2024-08-08T09:36:10.26Z\",\n  \"updated_at\": \"2024-08-08T09:36:10.26Z\",\n  \"application\": \"APgPDQrLD52TYvqazjHJJchM\",\n  \"entity\": {\n    \"ach_max_transaction_amount\": 0,\n    \"amex_mid\": null,\n    \"annual_card_volume\": 0,\n    \"business_address\": null,\n    \"business_name\": null,\n    \"business_phone\": null,\n    \"business_tax_id_provided\": false,\n    \"business_type\": null,\n    \"default_statement_descriptor\": null,\n    \"discover_mid\": null,\n    \"dob\": null,\n    \"doing_business_as\": null,\n    \"email\": null,\n    \"first_name\": \"Michael\",\n    \"has_accepted_credit_cards_previously\": false,\n    \"incorporation_date\": null,\n    \"last_name\": \"Johnson\",\n    \"max_transaction_amount\": 0,\n    \"mcc\": null,\n    \"ownership_type\": null,\n    \"personal_address\": {\n      \"line1\": \"789 Oak Drive\",\n      \"line2\": null,\n      \"city\": \"Springfield\",\n      \"region\": \"IL\",\n      \"postal_code\": \"62704\",\n      \"country\": \"USA\"\n    },\n    \"phone\": null,\n    \"principal_percentage_ownership\": null,\n    \"short_business_name\": null,\n    \"tax_authority\": null,\n    \"tax_id_provided\": false,\n    \"title\": null,\n    \"url\": null\n  },\n  \"identity_roles\": [\n    \"RECIPIENT\",\n    \"SENDER\"\n  ],\n  \"tags\": {},\n  \"type\": \"PERSONAL\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV\"\n    },\n    \"verifications\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/verifications\"\n    },\n    \"merchants\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/merchants\"\n    },\n    \"settlements\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/settlements\"\n    },\n    \"authorizations\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/authorizations\"\n    },\n    \"transfers\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/transfers\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/payment_instruments\"\n    },\n    \"associated_identities\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/associated_identities\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDdRDX7H6hNcm4HexJBeZVUV/disputes\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Business","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createIdentity","exampleKey":"Sender & Recipient (Business)","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/identities/responses/json/createIdentitySenderAndRecipientBusiness.jsonc","language":"json","title":"Sender & Recipient (Business)","header":{"title":"Sender & Recipient (Business)","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"IDjYHnn5kKQjpxh4gaFBih1n\",\n  \"created_at\": \"2024-08-08T09:26:15.85Z\",\n  \"updated_at\": \"2024-08-08T09:26:15.85Z\",\n  \"application\": \"APgPDQrLD52TYvqazjHJJchM\",\n  \"entity\": {\n    \"ach_max_transaction_amount\": 0,\n    \"amex_mid\": null,\n    \"annual_card_volume\": 0,\n    \"business_address\": {\n      \"line1\": \"7890 Oak Drive\",\n      \"line2\": \"Suite 101\",\n      \"city\": \"Smalltown\",\n      \"region\": \"TX\",\n      \"postal_code\": \"75432\",\n      \"country\": \"USA\"\n    },\n    \"business_name\": \"Blue Horizon Technologies\",\n    \"business_phone\": null,\n    \"business_tax_id_provided\": false,\n    \"business_type\": null,\n    \"default_statement_descriptor\": null,\n    \"discover_mid\": null,\n    \"dob\": null,\n    \"doing_business_as\": \"B.H. Technologies\",\n    \"email\": null,\n    \"first_name\": \"John\",\n    \"has_accepted_credit_cards_previously\": false,\n    \"incorporation_date\": null,\n    \"last_name\": \"Jeremy\",\n    \"max_transaction_amount\": 0,\n    \"mcc\": null,\n    \"ownership_type\": null,\n    \"personal_address\": {\n      \"line1\": \"741 Douglass St\",\n      \"line2\": \"Apartment 7\",\n      \"city\": \"San Mateo\",\n      \"region\": \"CA\",\n      \"postal_code\": \"94114\",\n      \"country\": \"USA\"\n    },\n    \"phone\": null,\n    \"principal_percentage_ownership\": null,\n    \"short_business_name\": null,\n    \"tax_authority\": null,\n    \"tax_id_provided\": false,\n    \"title\": null,\n    \"url\": null\n  },\n  \"identity_roles\": [\n    \"RECIPIENT\",\n    \"SENDER\"\n  ],\n  \"tags\": {},\n  \"type\": \"BUSINESS\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n\"\n    },\n    \"verifications\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/verifications\"\n    },\n    \"merchants\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/merchants\"\n    },\n    \"settlements\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/settlements\"\n    },\n    \"authorizations\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/authorizations\"\n    },\n    \"transfers\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/transfers\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/payment_instruments\"\n    },\n    \"associated_identities\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/associated_identities\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDjYHnn5kKQjpxh4gaFBih1n/disputes\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM\"\n    }\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-add-a-source-payment-instrument","__idx":4},"children":["Step 2: Add a Source Payment Instrument"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"PCI Level 1 Compliance"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creating ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment Instruments"]}," and passing payment details (account number, card number, etc.) directly via the API should only be done for testing purposes and by PCI Level 1 compliant entities. If you aren't a Level 1 PCI-compliant entity, you must use our ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/online-payments/payment-tokenization/tokenization-forms"},"children":["Tokenization Forms"]}," or ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/online-payments/payment-tokenization"},"children":["Mobile Tokenization"]}," to accept payment details and comply with PCI regulations. If you have any questions, please don't hesitate to reach out to your Finix point of contact or email the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/getting-started/support-at-finix/"},"children":["Finix Support team"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment Instrument"]}," for the source instrument that funds will be pulled from. This can be a card or a bank account."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Card","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createPaymentInstrument","exampleKey":"Payment Instrument - Card","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/payment_instruments/responses/json/createPaymentInstrumentCard.jsonc","language":"json","title":"Payment Instrument - Card","header":{"title":"Payment Instrument - Card","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"PI6F5kkcCB3dtGhFy1t8Aua5\",\n  \"created_at\": \"2024-11-15T09:42:33.42Z\",\n  \"updated_at\": \"2024-11-15T09:42:33.42Z\",\n  \"account_updater_enabled\": false,\n  \"application\": \"APgPDQrLD52TYvqazjHJJchM\",\n  \"created_via\": \"API\",\n  \"currency\": \"USD\",\n  \"disabled_code\": null,\n  \"disabled_message\": null,\n  \"enabled\": true,\n  \"fingerprint\": \"FPRiCenDk2SoRng7WjQTr7RJY\",\n  \"identity\": \"IDgWxBhfGYLLdkhxx2ddYf9K\",\n  \"instrument_type\": \"PAYMENT_CARD\",\n  \"address\": {\n    \"line1\": \"900 Metro Center Blv\",\n    \"line2\": null,\n    \"city\": \"San Francisco\",\n    \"region\": \"CA\",\n    \"postal_code\": \"94404\",\n    \"country\": \"USA\"\n  },\n  \"address_verification\": \"UNKNOWN\",\n  \"bin\": \"520082\",\n  \"brand\": \"MASTERCARD\",\n  \"card_type\": \"DEBIT\",\n  \"expiration_month\": 12,\n  \"expiration_year\": 2029,\n  \"issuer_country\": \"NON_USA\",\n  \"last_four\": \"8210\",\n  \"name\": \"John Jeremy\",\n  \"network_token_enabled\": false,\n  \"network_token_state\": \"NOT_ENABLED\",\n  \"security_code_verification\": \"UNKNOWN\",\n  \"tags\": {},\n  \"third_party\": null,\n  \"third_party_token\": null,\n  \"type\": \"PAYMENT_CARD\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5\"\n    },\n    \"authorizations\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations\"\n    },\n    \"transfers\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers\"\n    },\n    \"verifications\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM\"\n    },\n    \"identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K\"\n    },\n    \"updates\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Bank Account","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createPaymentInstrument","exampleKey":"Payment Instrument - Bank Account","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/payment_instruments/responses/json/createPaymentInstrumentBankAccount.jsonc","language":"json","title":"Payment Instrument - Bank Account","header":{"title":"Payment Instrument - Bank Account","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"PIkfiTDWYhQ4VbtQkC1U1ceJ\",\n  \"created_at\": \"2024-06-21T04:09:03.77Z\",\n  \"updated_at\": \"2024-06-21T04:09:03.77Z\",\n  \"application\": \"APgPDQrLD52TYvqazjHJJchM\",\n  \"created_via\": \"API\",\n  \"currency\": \"USD\",\n  \"disabled_code\": null,\n  \"disabled_message\": null,\n  \"enabled\": true,\n  \"fingerprint\": \"FPRxpMNPZbZqVQfcHzRUJnzkR\",\n  \"identity\": \"IDpYDM7J9n57q849o9E9yNrG\",\n  \"instrument_type\": \"BANK_ACCOUNT\",\n  \"account_type\": \"BUSINESS_CHECKING\",\n  \"bank_account_validation_check\": \"NOT_ATTEMPTED\",\n  \"bank_code\": \"122105278\",\n  \"country\": \"USA\",\n  \"institution_number\": null,\n  \"masked_account_number\": \"XXXXXX0019\",\n  \"name\": \"Smith & Associates Consulting\",\n  \"transit_number\": null,\n  \"tags\": {},\n  \"third_party\": null,\n  \"third_party_token\": null,\n  \"type\": \"BANK_ACCOUNT\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ\"\n    },\n    \"authorizations\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/authorizations\"\n    },\n    \"transfers\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/transfers\"\n    },\n    \"verifications\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/verifications\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM\"\n    },\n    \"identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG\"\n    }\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-optional-verify-the-source-payment-instrument","__idx":5},"children":["Step 3: (Optional) Verify the Source Payment Instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the source is a card, verify its eligibility for pull-from-card before proceeding. The resulting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Verification"]}," resource provides card details including card type and issuer information."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createPaymentInstrumentVerificationPushToCard","exampleKey":"Verify Push-to-Card Eligibility","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/requestBodies/payment_instruments/createPaymentInstrumentVerificationPushToCard.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/createPaymentInstrumentVerificationPushToCard"},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"createPaymentInstrumentVerificationPushToCard":{"type":"object","title":"Push-to-Card Eligibility","properties":{"processor":{"type":"string","enum":["DUMMY_V1","FINIX_V1"],"default":"DUMMY_V1","description":"The acquiring processor. Use `DUMMY_V1` to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email [Finix Support](/guides/getting-started/support-at-finix/)."},"tags":{"$ref":"#/components/schemas/tags"}},"required":["processor"]}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/payment_instruments/responses/json/createPaymentInstrumentVerificationPushToCard.jsonc","language":"json","title":"Card is eligible for push-to-card","header":{"title":"Card is eligible for push-to-card","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"VI9cSUm3SDaLKtuL92Z34rK9\",\n  \"created_at\": \"2025-11-07T20:36:16.90Z\",\n  \"updated_at\": \"2025-11-07T20:36:16.92Z\",\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"identity\": null,\n  \"merchant\": null,\n  \"merchant_identity\": null,\n  \"messages\": [],\n  \"outcome_summary\": null,\n  \"outcomes\": null,\n  \"payment_instrument\": \"PIn8as75qLQFqQ7G4NdBUk58\",\n  \"payment_instrument_verification_details\": {\n    \"push_to_card_domestic\": null,\n    \"push_to_card_cross_border\": null,\n    \"card_type\": null,\n    \"billing_currency\": null,\n    \"issuer_country\": \"UNKNOWN\",\n    \"name_verification_results\": {\n      \"first_name_verification\": \"UNKNOWN\",\n      \"last_name_verification\": \"UNKNOWN\",\n      \"middle_name_verification\": \"UNKNOWN\",\n      \"name_verification\": \"UNKNOWN\"\n    }\n  },\n  \"processor\": \"DUMMY_V1\",\n  \"raw\": null,\n  \"state\": \"PENDING\",\n  \"tags\": {\n    \"card_name\": \"Business_Card\"\n  },\n  \"trace_id\": \"63eefc66-81a3-4f24-a09d-bb7650e23943\",\n  \"type\": \"PAYMENT_INSTRUMENT\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/verifications/VI9cSUm3SDaLKtuL92Z34rK9\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"payment_instrument\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/resources/verifications/payment_instrument_verification.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/payment_instrument_verification"},"id":{"type":"string","minLength":1,"description":"The ID of the resource."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was last updated."},"application_id":{"type":"string","minLength":1,"description":"ID of the `Application` the resource was created under."},"name_verification_results":{"type":"object","nullable":true,"properties":{"first_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."}}},"raw":{"title":"Raw","description":"Raw response from the processor.","anyOf":[{"type":"object","nullable":true},{"type":"string","nullable":true}]},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"payment_instrument_verification":{"type":"object","title":"Payment Instrument Verification","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"type":"string","$ref":"#/components/schemas/application_id"},"identity":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"merchant":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"merchant_identity":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"messages":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"string"},"default":[]},"outcome_summary":{"type":"string","description":"A message providing additional context about why the verification request failed.","nullable":true,"default":null},"outcomes":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"object"},"nullable":true,"default":null},"payment_instrument":{"type":"string","description":"The `Payment Instrument` sent for verification.","default":null},"payment_instrument_verification_details":{"type":"object","description":"The payment instruction verification results.","properties":{"push_to_card_domestic":{"type":"string","description":"Indicates whether the `Payment Instrument` supports push-to-card and pull-from-card, domestically. For more details, see [Push to Card](/guides/payouts/card-payouts).","enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"push_to_card_cross_border":{"type":"string","description":"Indicates whether the `Payment Instrument` supports push-to-card and pull-from-card, cross-border. For more details, see [Push to Card](/guides/payouts/card-payouts).","enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"card_type":{"type":"string","description":"A code that indicates whether the card is credit, debit, or prepaid.","enum":["CREDIT","DEBIT","HSA_FSA","RELOADABLE_PREPAID","UNRELOADABLE_PREPAID","UNKNOWN"],"nullable":true,"default":null},"billing_currency":{"type":"string","description":"The currency in which the payment instrument's holder is billed or charged.","nullable":true,"default":null},"issuer_country":{"type":"string","description":"The country where the entity (bank or financial institution) that issued the payment instrument (e.g., credit card, debit card) is located.\n\n- `NON_USA` - The card was issued outside of the United States.\n- `USA` - The card was issued in the United States.\n- `UNKNOWN` - The processor did not return an issuer country for this particular BIN.\n","enum":["NON_USA","USA","UNKNOWN"],"nullable":true,"default":null},"name_verification_results":{"description":"Details the results of verifying the cardholder's name with the issuing bank. Only returned for `PAYMENT_CARD` type verifications on `FINIX_V1` and `VISA_V1` processors.","default":null,"allOf":[{"$ref":"#/components/schemas/name_verification_results"}]}}},"processor":{"type":"string","description":"Name of the verification processor.","enum":["FINIX_V1","DUMMY_V1"]},"raw":{"$ref":"#/components/schemas/raw"},"state":{"type":"string","description":"The state of the payment instrument verification request.","enum":["PENDING","FAILED","SUCCEEDED"]},"tags":{"$ref":"#/components/schemas/tags"},"trace_id":{"type":"string","description":"An ID used for tracking the verification request."},"type":{"type":"string","description":"Details the type of resource getting verified.","enum":["PAYMENT_INSTRUMENT"]},"_links":{"type":"object","description":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.","properties":{"self":{"type":"object","description":"Link to the `Verification`.","properties":{"href":{"type":"string"}}},"application":{"type":"object","description":"Link to the `Application` associated with this resource.","properties":{"href":{"type":"string"}}},"payment_instrument":{"type":"object","description":"Link to the `Payment Instrument` sent for verification.","properties":{"href":{"type":"string","minLength":1}}}}}}}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-add-a-destination-payment-instrument","__idx":6},"children":["Step 4: Add a Destination Payment Instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment Instrument"]}," for the destination instrument that will receive the funds. Me to Me payouts are only available for bank accounts or Visa and Mastercard cards."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createPaymentInstrument","exampleKey":"Payment Instrument - Card","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/requestBodies/payment_instruments/createPaymentInstrumentCard.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/createPaymentInstrumentCard"},"country":{"type":"string","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XKX","YEM","ZAF","ZMB","ZWE"],"nullable":true},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter State code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"$ref":"#/components/schemas/country"}},"required":["city","country","line1","postal_code","region"]},"security_code":{"type":"string","description":"The 3-or 4-digit security code for the card (i.e., the CVV code). While providing a CVV is optional, it is recommended to include it wherever possible to prevent fraud.\n","nullable":true},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"createPaymentInstrumentCard":{"title":"Payment Instrument - Card","type":"object","properties":{"address":{"description":"The address of the card owner.\n\n**Note**: Including a postal or zip code when creating a `Payment Instrument` can lower the interchange on credit card transactions.\n","allOf":[{"$ref":"#/components/schemas/address"}]},"expiration_month":{"type":"integer","description":"The expiration month of the card (e.g. 12 for December)."},"expiration_year":{"type":"integer","description":"The 4-digit expiration year of the card."},"identity":{"type":"string","description":"The ID of the `Identity` used to create the `Payment Instrument` resource."},"name":{"type":"string","description":"The name of the card owner. This value can get truncated to comply with processor requirements."},"number":{"type":"string","description":"The card or bank account number (no dashes in between numbers)."},"security_code":{"$ref":"#/components/schemas/security_code"},"tags":{"$ref":"#/components/schemas/tags"},"third_party_token":{"type":"string","description":"Stringified token provided by Apple or Google. Required if using Apple or Google Pay."},"type":{"type":"string","description":"Type of `Payment Instrument`.","enum":["PAYMENT_CARD"]}},"required":["expiration_month","expiration_year","identity","name","number","type"]}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/payment_instruments/responses/json/createPaymentInstrumentCard.jsonc","language":"json","title":"Payment Instrument - Card","header":{"title":"Payment Instrument - Card","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"PI6F5kkcCB3dtGhFy1t8Aua5\",\n  \"created_at\": \"2024-11-15T09:42:33.42Z\",\n  \"updated_at\": \"2024-11-15T09:42:33.42Z\",\n  \"account_updater_enabled\": false,\n  \"application\": \"APgPDQrLD52TYvqazjHJJchM\",\n  \"created_via\": \"API\",\n  \"currency\": \"USD\",\n  \"disabled_code\": null,\n  \"disabled_message\": null,\n  \"enabled\": true,\n  \"fingerprint\": \"FPRiCenDk2SoRng7WjQTr7RJY\",\n  \"identity\": \"IDgWxBhfGYLLdkhxx2ddYf9K\",\n  \"instrument_type\": \"PAYMENT_CARD\",\n  \"address\": {\n    \"line1\": \"900 Metro Center Blv\",\n    \"line2\": null,\n    \"city\": \"San Francisco\",\n    \"region\": \"CA\",\n    \"postal_code\": \"94404\",\n    \"country\": \"USA\"\n  },\n  \"address_verification\": \"UNKNOWN\",\n  \"bin\": \"520082\",\n  \"brand\": \"MASTERCARD\",\n  \"card_type\": \"DEBIT\",\n  \"expiration_month\": 12,\n  \"expiration_year\": 2029,\n  \"issuer_country\": \"NON_USA\",\n  \"last_four\": \"8210\",\n  \"name\": \"John Jeremy\",\n  \"network_token_enabled\": false,\n  \"network_token_state\": \"NOT_ENABLED\",\n  \"security_code_verification\": \"UNKNOWN\",\n  \"tags\": {},\n  \"third_party\": null,\n  \"third_party_token\": null,\n  \"type\": \"PAYMENT_CARD\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5\"\n    },\n    \"authorizations\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/authorizations\"\n    },\n    \"transfers\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/transfers\"\n    },\n    \"verifications\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/verifications\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM\"\n    },\n    \"identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K\"\n    },\n    \"updates\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI6F5kkcCB3dtGhFy1t8Aua5/updates\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/resources/payment_instruments/payment_instrument_card.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/payment_instrument_card"},"id":{"type":"string","minLength":1,"description":"The ID of the resource."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was last updated."},"created_via":{"type":"string","description":"The method by which the resource was created.","enum":["API"]},"account_updater_enabled_card":{"type":"boolean","description":"When enabled at the `Payment Instrument`-level, Finix automatically checks for updates with card networks. This Account Updater functionality:\n\n- Automatically updates card details (e.g., number or expiration date) to maintain continuity of charges, increasing authorization rates.\n- Saves the cardholder the hassle of updating card details across `Merchants` for each of their `Subscriptions`.\n\nIf set at the `Application` level, this `Payment Instrument`-level setting will override the `Application`-level configuration. If not configured at the `Application`-level, the card defaults to `false`, requiring explicit opt-in.\n\n**Note**: Cards created before the feature is enabled are unaffected by default. To include these cards, you can manually enable the Account Updater functionality for each card individually using a PUT request. Once enabled, you can link the card to this API call to trigger updates with card networks.\n","default":false},"country":{"type":"string","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XKX","YEM","ZAF","ZMB","ZWE"],"nullable":true},"address":{"type":"object","properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter State code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"$ref":"#/components/schemas/country"}},"required":["city","country","line1","postal_code","region"]},"application_id":{"type":"string","minLength":1,"description":"ID of the `Application` the resource was created under."},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"identity_id":{"type":"string","description":"The ID of the `Identity` used to create the resource."},"network_token_enabled_card":{"type":"boolean","description":"When enabled at the `Payment Instrument` level, a \"network token\" replaces raw card details (e.g., the 16-digit PAN and expiration date) for transactions. Network tokens have several benefits:\n\n- The token offers increased authorization rates, even for lost or stolen cards, as it remains valid while the physical card is replaced.\n- Visa reduces interchange fees when using network tokens.\n- Tokens enhance security by replacing card details with a non-sensitive string that is usable only within the Finix system.\n\nIf set at the `Application` level, this `Payment Instrument` level setting will override the application level configuration.  If not configured at the application level, the card defaults to `false`, requiring explicit opt-in.\n\n**Note**: Cards created before the feature is enabled are unaffected. To include them, update an individual `Payment Instrument`. Then, you can insert the hyperlink on the \"update\".\n","default":false},"name_verification_results":{"type":"object","nullable":true,"properties":{"first_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."}}},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"payment_instrument_card":{"type":"object","title":"Payment Instrument - Card","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"created_via":{"$ref":"#/components/schemas/created_via"},"account_updater_enabled":{"$ref":"#/components/schemas/account_updater_enabled_card"},"address":{"description":"The address of the card owner. Including a postal or zip code when creating a `Payment Instrument` can lower the interchange on credit card transactions.","allOf":[{"$ref":"#/components/schemas/address"}]},"address_verification":{"type":"string","enum":["POSTAL_CODE_AND_STREET_MATCH","STREET_MATCH","POSTAL_CODE_MATCH","NO_ADDRESS","NO_MATCH","NOT_SUPPORTED","UNKNOWN"],"description":"- Details the results of verifying `address` with the issuing bank.\n- Set to **UNKNOWN** when `address` gets updated."},"application":{"$ref":"#/components/schemas/application_id"},"bin":{"type":"string","description":"Bank Identification number for the `Payment Instrument`."},"brand":{"type":"string","enum":["UNKNOWN","DINERS_CLUB_INTERNATIONAL","DANKORT","MIR","TROY","UATP","CHINA_T_UNION","CHINA_UNION_PAY","AMERICAN_EXPRESS","VERVE","RUPAY","DISCOVER","JCB","MASTERCARD","INTERPAYMENT","INSTAPAYMENT","MAESTRO","VISA","LANKAPAY","DINERS_CLUB","INTERAC"],"description":"The `brand` of the card saved in the `Payment Instrument`."},"card_type":{"type":"string","enum":["CREDIT","DEBIT","HSA_FSA","NON_RELOADABLE_PREPAID","RELOADABLE_PREPAID","UNKNOWN"],"description":"The type of payment card saved in the `Payment Instrument`."},"country":{"$ref":"#/components/schemas/country"},"currency":{"$ref":"#/components/schemas/currency"},"disabled_code":{"type":"string","description":"A code indicating why the `Payment Instrument` was disabled. This field is populated when the card is automatically disabled for reasons other than `USER INITIATED` or when manually disabled by a user for `USER_INITIATED`.\n\nSee `disabled_message` for possible error codes and their messages.\n","enum":["CARD_ACCOUNT_CLOSED","INVALID_ACCOUNT_NUMBER","LOST_OR_STOLEN_CARD","NON_RELOADABLE_INSUFFICIENT_FUNDS","PICK_UP_CARD","RESTRICTED_CARD","USER_INITIATED"],"nullable":true},"disabled_message":{"type":"string","description":"A human-readable message explaining why the `Payment Instrument` was disabled. This field provides additional context for the `disabled_code`.\n\nThe possible error codes/messages are:\n- `CARD_ACCOUNT_CLOSED`: \"The card account has been closed. The card has been disabled to prevent further use.\"\n- `INVALID_ACCOUNT_NUMBER`: \"The card number is not valid. The card has been disabled to prevent further use.\"\n- `LOST_OR_STOLEN_CARD`: \"The card is reported lost or stolen. The card has been disabled to prevent further use.\"\n- `NON_RELOADABLE_INSUFFICIENT_FUNDS`: \"The card has insufficient funds for the transaction and is non-reloadable. The card has been disabled to prevent further use.\"\n- `PICK_UP_CARD`: \"The card is reported lost or stolen. The card has been disabled to prevent further use.\"\n- `RESTRICTED_CARD`: \"The card has a restriction preventing approval for this transaction. The card has been disabled to prevent further use.\"\n- `USER_INITIATED`: \"The card has been disabled by a user.\"\n","nullable":true},"enabled":{"type":"boolean","description":"Indicates whether the `Payment Instrument` resource is enabled. The default value is `true`; set it to `false` to disable the `Payment Instrument`. The user or the system can update this field to enable or disable the payment instrument."},"expiration_month":{"type":"integer","maximum":12,"minimum":1,"description":"Expiration month (e.g. 12 for December)."},"expiration_year":{"type":"integer","minimum":1,"description":"4-digit expiration year."},"fast_funds_indicator":{"type":"string","description":"Details if Fast Funds is enabled for the card."},"fingerprint":{"type":"string","example":"FPRxxxxxxxxxxxxxxxxx","description":"Unique ID that represents the tokenized card data."},"identity":{"$ref":"#/components/schemas/identity_id"},"instrument_type":{"type":"string","enum":["PAYMENT_CARD","PAYMENT_CARD_PRESENT","TOKEN"],"description":"The type of `Payment Instrument`."},"issuer_country":{"type":"string","description":"The Alpha-3 Code of the country the card was issued in.\n\nIn addition, the following values are possible:\n\n- `NON_USA` - The card was issued outside of the United States.\n- `UNKNOWN` - The processor did not return an issuer country for this particular BIN.\n","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NON_USA","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","UNKNOWN","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","ZAF","ZMB","ZWE"]},"last_four":{"type":"string","description":"Last four digits of the card."},"name":{"type":"string","description":"The name of the card owner.","nullable":true},"network_token_enabled":{"$ref":"#/components/schemas/network_token_enabled_card"},"network_token_state":{"type":"string","description":"The state of the network token. The possible enum values are as follows:\n\n- `NOT_ENABLED`: The `network_token_state` is `NOT_ENABLED` when the value of `network_token_enabled` on the `Payment Instrument` is `false`.\n- `PENDING`: Immediately after Finix enables network tokens for a specific card, `network_token_state` is initially set to `PENDING`.\n- `ACTIVE`: After Finix receives the network token successfully from the card network, `network_token_state` updates to `ACTIVE`.\n- `FAILED`: In the event that there is an issue with the card network such as service becomes unavailable, `FAILED` is returned.\n- `SUSPENDED`: When the issuing bank does not allow the network token to be used in transactions, `SUSPENDED` is returned.\n- `CLOSED`: In the event that the issuing bank has closed the card permanently, `CLOSED` is returned.\n","enum":["ACTIVE","CLOSED","FAILED","NOT_ENABLED","SUSPENDED","PENDING"]},"payload_type":{"type":"string","enum":["SOURCE","DESTINATION"]},"push_funds_block_indicator":{"type":"string","description":"Details if the card is enabled to receive push-to-card disbursements."},"name_verification_results":{"description":"Details the results of verifying the cardholder's name with the issuing bank. Returns `null` if `name_verification_details` was not included in the request.","allOf":[{"$ref":"#/components/schemas/name_verification_results"}]},"security_code_verification":{"type":"string","enum":["MATCHED","UNKNOWN","UNMATCHED"],"description":"Details the results of the Card Verification Code check."},"third-party":{"type":"string","description":"This field is not applicable to payment cards.","nullable":true},"third_party_token":{"type":"string","description":"This field is not applicable to payment cards.","nullable":true},"type":{"type":"string","enum":["PAYMENT_CARD","TOKEN","GOOGLE_PAY","APPLE_PAY"],"description":"Type of `Payment Instrument`."},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.","properties":{"application":{"type":"object","description":"Link to the `Application` the request was made under.","properties":{"href":{"type":"string"}}},"authorizations":{"type":"object","description":"Link to the `Authorizations` created under the resource.","properties":{"href":{"type":"string"}}},"identity":{"type":"object","description":"Link to the `Identity` the request was made under.","properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}},"transfers":{"type":"object","description":"Link to the `Transfers` created under the resource.","properties":{"href":{"type":"string"}}},"updates":{"type":"object","description":"Link to the `Updates` created under the resource.","properties":{"href":{"type":"string"}}},"verifications":{"type":"object","description":"Link to the `Verification` that was used to verify the `Merchant` that the request was made under.","properties":{"href":{"type":"string"}}}}}}}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5-optional-verify-the-destination-payment-instrument","__idx":7},"children":["Step 5: (Optional) Verify the Destination Payment Instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If pushing to a card you can verify the destination card's eligibility for push-to-card before sending funds."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createPaymentInstrumentVerificationPushToCard","exampleKey":"Verify Push-to-Card Eligibility","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/requestBodies/payment_instruments/createPaymentInstrumentVerificationPushToCard.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/createPaymentInstrumentVerificationPushToCard"},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"createPaymentInstrumentVerificationPushToCard":{"type":"object","title":"Push-to-Card Eligibility","properties":{"processor":{"type":"string","enum":["DUMMY_V1","FINIX_V1"],"default":"DUMMY_V1","description":"The acquiring processor. Use `DUMMY_V1` to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email [Finix Support](/guides/getting-started/support-at-finix/)."},"tags":{"$ref":"#/components/schemas/tags"}},"required":["processor"]}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/payment_instruments/responses/json/createPaymentInstrumentVerificationPushToCard.jsonc","language":"json","title":"Card is eligible for push-to-card","header":{"title":"Card is eligible for push-to-card","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"VI9cSUm3SDaLKtuL92Z34rK9\",\n  \"created_at\": \"2025-11-07T20:36:16.90Z\",\n  \"updated_at\": \"2025-11-07T20:36:16.92Z\",\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"identity\": null,\n  \"merchant\": null,\n  \"merchant_identity\": null,\n  \"messages\": [],\n  \"outcome_summary\": null,\n  \"outcomes\": null,\n  \"payment_instrument\": \"PIn8as75qLQFqQ7G4NdBUk58\",\n  \"payment_instrument_verification_details\": {\n    \"push_to_card_domestic\": null,\n    \"push_to_card_cross_border\": null,\n    \"card_type\": null,\n    \"billing_currency\": null,\n    \"issuer_country\": \"UNKNOWN\",\n    \"name_verification_results\": {\n      \"first_name_verification\": \"UNKNOWN\",\n      \"last_name_verification\": \"UNKNOWN\",\n      \"middle_name_verification\": \"UNKNOWN\",\n      \"name_verification\": \"UNKNOWN\"\n    }\n  },\n  \"processor\": \"DUMMY_V1\",\n  \"raw\": null,\n  \"state\": \"PENDING\",\n  \"tags\": {\n    \"card_name\": \"Business_Card\"\n  },\n  \"trace_id\": \"63eefc66-81a3-4f24-a09d-bb7650e23943\",\n  \"type\": \"PAYMENT_INSTRUMENT\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/verifications/VI9cSUm3SDaLKtuL92Z34rK9\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"payment_instrument\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/resources/verifications/payment_instrument_verification.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/payment_instrument_verification"},"id":{"type":"string","minLength":1,"description":"The ID of the resource."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was last updated."},"application_id":{"type":"string","minLength":1,"description":"ID of the `Application` the resource was created under."},"name_verification_results":{"type":"object","nullable":true,"properties":{"first_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name_verification":{"type":"string","enum":["MATCH","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."}}},"raw":{"title":"Raw","description":"Raw response from the processor.","anyOf":[{"type":"object","nullable":true},{"type":"string","nullable":true}]},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"payment_instrument_verification":{"type":"object","title":"Payment Instrument Verification","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"type":"string","$ref":"#/components/schemas/application_id"},"identity":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"merchant":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"merchant_identity":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"messages":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"string"},"default":[]},"outcome_summary":{"type":"string","description":"A message providing additional context about why the verification request failed.","nullable":true,"default":null},"outcomes":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"object"},"nullable":true,"default":null},"payment_instrument":{"type":"string","description":"The `Payment Instrument` sent for verification.","default":null},"payment_instrument_verification_details":{"type":"object","description":"The payment instruction verification results.","properties":{"push_to_card_domestic":{"type":"string","description":"Indicates whether the `Payment Instrument` supports push-to-card and pull-from-card, domestically. For more details, see [Push to Card](/guides/payouts/card-payouts).","enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"push_to_card_cross_border":{"type":"string","description":"Indicates whether the `Payment Instrument` supports push-to-card and pull-from-card, cross-border. For more details, see [Push to Card](/guides/payouts/card-payouts).","enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"card_type":{"type":"string","description":"A code that indicates whether the card is credit, debit, or prepaid.","enum":["CREDIT","DEBIT","HSA_FSA","RELOADABLE_PREPAID","UNRELOADABLE_PREPAID","UNKNOWN"],"nullable":true,"default":null},"billing_currency":{"type":"string","description":"The currency in which the payment instrument's holder is billed or charged.","nullable":true,"default":null},"issuer_country":{"type":"string","description":"The country where the entity (bank or financial institution) that issued the payment instrument (e.g., credit card, debit card) is located.\n\n- `NON_USA` - The card was issued outside of the United States.\n- `USA` - The card was issued in the United States.\n- `UNKNOWN` - The processor did not return an issuer country for this particular BIN.\n","enum":["NON_USA","USA","UNKNOWN"],"nullable":true,"default":null},"name_verification_results":{"description":"Details the results of verifying the cardholder's name with the issuing bank. Only returned for `PAYMENT_CARD` type verifications on `FINIX_V1` and `VISA_V1` processors.","default":null,"allOf":[{"$ref":"#/components/schemas/name_verification_results"}]}}},"processor":{"type":"string","description":"Name of the verification processor.","enum":["FINIX_V1","DUMMY_V1"]},"raw":{"$ref":"#/components/schemas/raw"},"state":{"type":"string","description":"The state of the payment instrument verification request.","enum":["PENDING","FAILED","SUCCEEDED"]},"tags":{"$ref":"#/components/schemas/tags"},"trace_id":{"type":"string","description":"An ID used for tracking the verification request."},"type":{"type":"string","description":"Details the type of resource getting verified.","enum":["PAYMENT_INSTRUMENT"]},"_links":{"type":"object","description":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.","properties":{"self":{"type":"object","description":"Link to the `Verification`.","properties":{"href":{"type":"string"}}},"application":{"type":"object","description":"Link to the `Application` associated with this resource.","properties":{"href":{"type":"string"}}},"payment_instrument":{"type":"object","description":"Link to the `Payment Instrument` sent for verification.","properties":{"href":{"type":"string","minLength":1}}}}}}}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-6-verify-and-onboard-the-account","__idx":8},"children":["Step 6: Verify and Onboard the Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provision a recipient account by making a POST request to create a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Merchant"]}," resource. This is the last step before you can begin sending Me to Me payouts. Once the merchant is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Approved"]}," you can create a transfer to pull funds. For more information, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/payouts/recipient-verification-process"},"children":["Recipient Verifications"]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createMerchant","exampleKey":"Merchant - Minimal Fields","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/requestBodies/identities/createMerchant.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/createMerchant"},"processor_request":{"description":"Set the acquiring processor. Use `DUMMY_V1` or `null` for your Sandbox. For more details on which processor to use, reach out to your Finix point of contact or email [Finix Support](/guides/getting-started/support-at-finix/).\n","type":"string","nullable":false,"enum":["DUMMY_V1","FINIX_V1"]},"refunds_disabled_merchant":{"type":"boolean","default":false,"description":"A value of `true` disables refunds for the `Merchant`, including both referenced and unreferenced refunds."},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"createMerchant":{"title":"Merchant - All Fields","type":"object","properties":{"default_partial_authorization_enabled":{"type":"boolean","default":false,"description":"- Set to **true** if you want to enable partial authorizations for a specific `Merchant`.\n- Partial authorizations enable the `Merchant` to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card."},"loan_repayment":{"type":"boolean","default":false,"description":"Set to `true` to enable the `Merchant` to process debt loan repayment. Only MCCs `6012` and `6051` are eligible."},"processor":{"$ref":"#/components/schemas/processor_request"},"refunds_disabled":{"$ref":"#/components/schemas/refunds_disabled_merchant"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["processor"]}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/identities/responses/json/createMerchantMinimalFields.jsonc","language":"json","title":"Merchant","header":{"title":"Merchant","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"MUeTBamsYxqr1KSnT4U2x9SP\",\n  \"created_at\": \"2024-08-16T13:11:36.72Z\",\n  \"updated_at\": \"2024-08-16T13:11:36.72Z\",\n  \"application\": \"APgPDQrLD52TYvqazjHJJchM\",\n  \"card_cvv_required\": false,\n  \"card_expiration_date_required\": true,\n  \"card_network_details\": null,\n  \"convenience_charges_enabled\": false,\n  \"country\": \"USA\",\n  \"creating_transfer_from_report_enabled\": true,\n  \"currencies\": [\n    \"USD\"\n  ],\n  \"default_partial_authorization_enabled\": false,\n  \"disbursements_ach_pull_enabled\": false,\n  \"disbursements_ach_push_enabled\": false,\n  \"disbursements_card_pull_enabled\": false,\n  \"disbursements_card_push_enabled\": false,\n  \"disbursements_same_day_ach_pull_enabled\": false,\n  \"disbursements_same_day_ach_push_enabled\": false,\n  \"fee_ready_to_settle_upon\": \"RECONCILIATION\",\n  \"gateway\": null,\n  \"gross_settlement_enabled\": false,\n  \"identity\": \"ID6ZC4KedcaCwECQcWr7SM4m\",\n  \"instant_payouts_card_push_enabled\": false,\n  \"level_two_level_three_data_enabled\": false,\n  \"loan_repayment\": null,\n  \"mcc\": \"4900\",\n  \"merchant_name\": \"Blue Horizon Technologies\",\n  \"merchant_profile\": \"MP8aC84QAtA69Qhv6BJSyvHr\",\n  \"mid\": null,\n  \"onboarding_state\": \"PROVISIONING\",\n  \"processing_enabled\": false,\n  \"processor\": \"DUMMY_V1\",\n  \"processor_details\": {},\n  \"ready_to_settle_upon\": \"RECONCILIATION\",\n  \"ready_to_settle_upon_delay_alignment\": \"NONE\",\n  \"rent_surcharges_enabled\": false,\n  \"settlement_enabled\": false,\n  \"settlement_funding_identifier\": \"UNSET\",\n  \"surcharges_enabled\": false,\n  \"tags\": {\n    \"key_2\": \"value_2\"\n  },\n  \"unreferenced_refund_manual_entry_enabled\": false,\n  \"verification\": \"VI7jopNSiaVMXWKkhxt6dJm7\",\n  \"_links\": {\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/merchants/MUeTBamsYxqr1KSnT4U2x9SP\"\n    },\n    \"identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/ID6ZC4KedcaCwECQcWr7SM4m\"\n    },\n    \"verifications\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/merchants/MUeTBamsYxqr1KSnT4U2x9SP/verifications\"\n    },\n    \"merchant_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/merchant_profiles/MP8aC84QAtA69Qhv6BJSyvHr\"\n    },\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM\"\n    },\n    \"verification\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/verifications/VI7jopNSiaVMXWKkhxt6dJm7\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"API Definition","disable":false},"children":[{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../api/components/schemas/resources/merchants/merchant.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/merchant"},"id":{"type":"string","minLength":1,"description":"The ID of the resource."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the object was last updated."},"country":{"type":"string","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XKX","YEM","ZAF","ZMB","ZWE"],"nullable":true},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"refunds_disabled_merchant":{"type":"boolean","default":false,"description":"A value of `true` disables refunds for the `Merchant`, including both referenced and unreferenced refunds."},"tags":{"type":"object","title":"tags","additionalProperties":{"type":"string"},"description":"Include up to 50 `key: value` pairs to annotate requests with custom metadata.\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n(For example, `order_number: 25`, `item_type: produce`, `department: sales`)","nullable":true},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string","minLength":1}}},"identity_link":{"type":"object","description":"Link to the `Identity` the request was made under.","properties":{"href":{"type":"string"}}},"verifications":{"type":"object","description":"Link to the `Verification` the request was made under.","properties":{"href":{"type":"string","minLength":1}}},"merchant_profiles":{"type":"object","description":"Link to the `merchant_profile` the request was made under.","properties":{"href":{"type":"string"}}},"application_link":{"type":"object","description":"Link to the `Application` the request was made under.","properties":{"href":{"type":"string","minLength":1}}},"merchant":{"title":"Merchant Schema","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"type":"string","minLength":1,"description":"ID of the `Application` associated with the resource."},"card_cvv_required":{"type":"boolean","description":"Set to `true` to require the card's CVV code."},"card_expiration_date_required":{"type":"boolean","description":"Set to `true` to require the card's expiration date."},"card_network_details":{"type":"object","nullable":true},"convenience_charges_enabled":{"type":"boolean","description":"Set to `true` if you want to enable the `Merchant` to accept convenience fees and/or service fees."},"country":{"description":"The `Merchant`'s country.","allOf":[{"$ref":"#/components/schemas/country"}]},"creating_transfer_from_report_enabled":{"type":"boolean","description":"Set to `true` to automatically create `Transfers` once settlement reports get generated."},"currencies":{"type":"array","description":"ISO 4217 3-letter currency code.","nullable":true,"items":{"$ref":"#/components/schemas/currency"}},"default_partial_authorization_enabled":{"type":"boolean","default":false,"description":"- Set to **true** if you want to enable partial authorizations for a specific `Merchant`.\n- Partial authorizations enable the `Merchant` to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card.\n"},"disbursements_same_day_ach_pull_enabled":{"type":"boolean","description":"Indicates whether same-day ACH pull disbursements (debits) are enabled, allowing funds to be withdrawn from an account via same-day ACH transfer."},"disbursements_same_day_ach_push_enabled":{"type":"boolean","description":"Indicates whether same-day ACH push disbursements (credits) are enabled, allowing funds to be sent to an account via same-day ACH transfer."},"fee_ready_to_settle_upon":{"type":"string","description":"Details how the `Merchant` settles fees.","enum":["RECONCILIATION","SUCCESSFUL_CAPTURE","PROCESSOR_WINDOW","CONFIGURABLE_WINDOW"]},"first_approved_at":{"type":"string","format":"date-time","description":"This field shows the timestamp when the `Merchant` was first approved. If the `Merchant` has not been approved yet, the value is `null`.\n","nullable":true},"gross_settlement_enabled":{"type":"boolean","description":"Set to `true` to enable gross settlements."},"identity":{"type":"string","description":"The ID of the `Identity` resource associated with the `Merchant`."},"instant_payouts_card_push_enabled":{"type":"boolean","description":"Set to `true` if you want to allow the merchant to be enabled for settlement instant payouts.","default":false},"is_terminated":{"type":"boolean","description":"Set to `true` to terminate the `Merchant`. A merchant can only be terminated if its current `onboarding_state` is `APPROVED`."},"level_two_level_three_data_enabled":{"type":"boolean","description":"Set to `true` to enable the `Merchant` for Level 2 and Level 3 processing. Default value is `false`."},"loan_repayment":{"type":"boolean","default":false,"description":"Whether the merchant is able to support loan repayment on the card networks.\n"},"mcc":{"type":"string","description":"The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card\\_x/mcc.pdf)) that this merchant will be classified under. For a list of approved MCCs, see [Approved Merchant Category Codes.](/guides/managing-operations/security-compliance/approved-merchant-category-codes)","nullable":true},"merchant_name":{"type":"string","description":"The legal name saved in the `Merchant` resource."},"merchant_profile":{"type":"string","description":"Details if a merchant's info was submitted to third-party processors for provisioning."},"mid":{"type":"string","description":"MID of the `Merchant`.","nullable":true},"onboarding_state":{"type":"string","enum":["APPROVED","PROVISIONING","REJECTED","UPDATE_REQUESTED"],"description":"Details the state of the `Merchant's` onboarding."},"processing_enabled":{"type":"boolean","description":"Details if transaction processing is enabled for the `Merchant`. `ROLE_PARTNER` can only set this value to `false`."},"processor":{"type":"string","description":"Name of the transaction processor.","enum":["FINIX_V1","DUMMY_V1"]},"processor_details":{"type":"object","description":"Additional details specific to the processor.","properties":{"mid":{"type":"string"},"api_key":{"type":"string"}}},"ready_to_settle_upon":{"type":"string","description":"Details how transactions captured by the `Merchant` are settled.","enum":["RECONCILIATION","SUCCESSFUL_CAPTURE","PROCESSOR_WINDOW","CONFIGURABLE_WINDOW"]},"ready_to_settle_upon_delay_alignment":{"type":"string","description":"Indicates whether transaction settlement should be delayed to synchronize the timing of all transactions, including both card and ACH, ensuring they are settled together.\n\nPossible values include:\n\n- `ACH` - Align all transactions to match the timing of ACH settlements, so card transactions settle at the same speed as ACH transactions.\n- `NONE` - Default behavior where card transactions settle the next day (T+1) and ACH transactions settle two days later (T+2).\n","enum":["ACH","NONE"]},"refunds_disabled":{"$ref":"#/components/schemas/refunds_disabled_merchant"},"rent_surcharges_enabled":{"type":"boolean","description":"Set to `true` if you want to enable a `Merchant` to accept rent charges."},"settlement_enabled":{"type":"boolean","description":"Details if settlement approvals are enabled for the `Merchant`. `ROLE_PARTNER` can only set this value to false."},"settlement_funding_identifier":{"type":"string","description":"Includes additional information (like the MID or `Merchant` name) when submitting funding `Transfers` to processors.\n- `UNSET`: No additional details get provided to the processor.\n- `MID_AND_DATE`: The `MID` of the `Merchant` and the date the funding `Transfer` was submitted (Date is in UTC). e.g `MID:12345678-20220225`\n- `MID_AND_MERCHANT_NAME`: The `MID` of the `Merchant` and the `Merchant#name` (white spaces will be removed). e.g. `MID:12345678-NameOfMerchant`\n\nThese details appear alongside the seller's payout in their bank account as a description of the deposit.","enum":["UNSET","MID_AND_DATE","MID_AND_MERCHANT_NAME"],"default":"UNSET"},"settlement_queue_mode":{"type":"string","description":"If `settlement_queue_mode` is set to `MANUAL`, Finix will automatically place all transactions (Sales, Fees, Refunds, and ACH Returns) into a settlement queue that you can manage. Each transaction will have a `Settlement Queue Entry`.\n\nWhen a `Settlement Queue Entry` is created, it will not be placed into `Settlement` until the `Settlement Queue Entry` is explicitly released.\n\nNote: We require the release of all settlement queue entries within 30 days of creation.\n","enum":["UNSET","MANUAL"]},"surcharges_enabled":{"type":"boolean","default":false,"description":"Set to `true` if you want to enable a `Merchant` to accept surcharge fees. For more details, see [Buyer Charges](/guides/online-payments/payment-features/buyer-charges)."},"tags":{"$ref":"#/components/schemas/tags"},"termination_details":{"type":"object","properties":{"terminated_at":{"type":"string","title":"CreatedAt","format":"date-time","example":"2024-09-16T13:11:36.72Z","description":"Timestamp indicating when the termination occurred."},"reason":{"type":"string","description":"The reason for termination.","enum":["CHURNED","COMPLIANCE_VIOLATION","EXCESSIVE_ACH_RETURNS","EXCESSIVE_CHARGEBACKS","FRAUD","IDENTITY_THEFT","ILLEGAL_TRANSACTIONS","INSOLVENCY","OTHER","PCI_VIOLATION","PROCESSOR_MIGRATION","SUSPECTED_FRAUD","UNSUPPORTED_BUSINESS_TYPE","UNUSUAL_ACTIVITY","VIOLATED_MERCHANT_TERMS_OF_SERVICE"]},"description":{"type":"string","description":"An explanation that provides context for the termination.","maxLength":1000},"terminated_by":{"type":"string","description":"The role that initiated the termination. If the API key belongs to the `USER` role, the following values will be returned:\n  - If the role is `ROLE_PLATFORM`, it will return `PLATFORM_USER`.\n  - If the role is `ROLE_PARTNER`, it will return `PARTNER_USER`.\n","enum":["PLATFORM_USER","PARTNER_USER"]},"terminated_by_user_id":{"type":"string","description":"The `User` ID of the user who initiated the termination of the `Merchant` account."}}},"unreferenced_refund_manual_entry_enabled":{"type":"boolean","default":false,"description":"Indicates if merchant is allowed to process unreferenced refunds initiated through manual card entry on Finix terminals."},"verification":{"type":"string","description":"ID of the `Verification` that was submitted to verify the `Merchant`."},"_links":{"type":"object","description":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.","properties":{"self":{"$ref":"#/components/schemas/self"},"identity":{"$ref":"#/components/schemas/identity_link"},"verifications":{"$ref":"#/components/schemas/verifications"},"merchant_profiles":{"$ref":"#/components/schemas/merchant_profiles"},"application":{"$ref":"#/components/schemas/application_link"}}}}}}}},"schemaResolvedErrors":[]},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-7-create-a-transfer-to-pull-funds","__idx":9},"children":["Step 7: Create a Transfer to Pull Funds"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Transfer"]}," to pull funds from the customer's source payment instrument. Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["funds_flow_type"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ME_TO_ME"]}," and include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment Instrument"]}," ID as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The pull transfer must reach a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]}," before you can create the payout transfer. It is recommended to include an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idempotency_id"]}," field in the payload. For more information, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/additional-resources/developers/authentication-and-api-basics/idempotent-request"},"children":["Idempotent Requests"]},"."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Pull from Card","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createTransfer","exampleKey":"Transfer - Me to Me Pull - Card","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/transfers/responses/json/createTransferMeToMePullCard.jsonc","language":"json","title":"Transfer - Me to Me Pull - Card","header":{"title":"Transfer - Me to Me Pull - Card","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"TR3vKfwCuXmLqPsDYbGYn4NUm\",\n  \"created_at\": \"2025-08-14T21:45:12.98Z\",\n  \"updated_at\": \"2025-08-14T21:45:12.98Z\",\n  \"additional_buyer_charges\": null,\n  \"additional_healthcare_data\": null,\n  \"additional_purchase_data\": null,\n  \"address_verification\": null,\n  \"amount\": 15000,\n  \"amount_requested\": 15000,\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"currency\": \"USD\",\n  \"destination\": null,\n  \"externally_funded\": \"UNKNOWN\",\n  \"failure_code\": null,\n  \"failure_message\": null,\n  \"fee\": 0,\n  \"fee_profile\": \"FPmtT4MYmiAs1qjLjneQmk4d\",\n  \"funds_flow_type\": \"ME_TO_ME\",\n  \"idempotency_id\": null,\n  \"merchant\": \"MUuNdhs7uVYcjocWugeBbpRo\",\n  \"merchant_identity\": \"IDbPrApp2adDVqG4QQzoo58E\",\n  \"messages\": [],\n  \"network_details\": {},\n  \"operation_key\": \"PULL_FROM_CARD\",\n  \"parent_transfer\": null,\n  \"parent_transfer_trace_id\": null,\n  \"raw\": null,\n  \"ready_to_settle_at\": null,\n  \"receipt_last_printed_at\": null,\n  \"security_code_verification\": null,\n  \"source\": \"PIveyqg2bVkKo6SHsstxBSDc\",\n  \"split_transfers\": [],\n  \"state\": \"SUCCEEDED\",\n  \"statement_descriptor\": null,\n  \"subtype\": \"API\",\n  \"supplemental_fee\": null,\n  \"tags\": {},\n  \"tip_amount\": null,\n  \"trace_id\": \"84749ef6-2018-5105-b4gg-g684e8g4f458\",\n  \"type\": \"DEBIT\",\n  \"_links\": {\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR3vKfwCuXmLqPsDYbGYn4NUm\"\n    },\n    \"merchant_identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDbPrApp2adDVqG4QQzoo58E\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR3vKfwCuXmLqPsDYbGYn4NUm/payment_instruments\"\n    },\n    \"reversals\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR3vKfwCuXmLqPsDYbGYn4NUm/reversals\"\n    },\n    \"fees\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR3vKfwCuXmLqPsDYbGYn4NUm/fees\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR3vKfwCuXmLqPsDYbGYn4NUm/disputes\"\n    },\n    \"source\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIveyqg2bVkKo6SHsstxBSDc\"\n    },\n    \"fee_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Pull from Bank (Next Day ACH)","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createTransfer","exampleKey":"Transfer - Me to Me Pull - Bank","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/transfers/responses/json/createTransferMeToMePullBank.jsonc","language":"json","title":"Transfer - Me to Me Pull - Bank","header":{"title":"Transfer - Me to Me Pull - Bank","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"TR4mNhCuXkAqRsDYbJYnBCDe\",\n  \"created_at\": \"2025-08-14T20:59:09.39Z\",\n  \"updated_at\": \"2025-08-14T20:59:09.39Z\",\n  \"additional_buyer_charges\": null,\n  \"additional_healthcare_data\": null,\n  \"additional_purchase_data\": null,\n  \"address_verification\": null,\n  \"amount\": 15000,\n  \"amount_requested\": 15000,\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"currency\": \"USD\",\n  \"destination\": null,\n  \"externally_funded\": \"UNKNOWN\",\n  \"failure_code\": null,\n  \"failure_message\": null,\n  \"fee\": 0,\n  \"fee_profile\": \"FPmtT4MYmiAs1qjLjneQmk4d\",\n  \"funds_flow_type\": \"ME_TO_ME\",\n  \"idempotency_id\": null,\n  \"merchant\": \"MU2bESfmfedhA2SjcymNvSAX\",\n  \"merchant_identity\": \"IDA3M8ueFuXaJex7N6jcAR9\",\n  \"messages\": [],\n  \"network_details\": {},\n  \"operation_key\": \"PULL_FROM_ACH\",\n  \"parent_transfer\": null,\n  \"parent_transfer_trace_id\": null,\n  \"raw\": null,\n  \"ready_to_settle_at\": null,\n  \"receipt_last_printed_at\": null,\n  \"security_code_verification\": null,\n  \"source\": \"PI95jTbyzcdjhWsgFEK6vqSU\",\n  \"split_transfers\": [],\n  \"state\": \"PENDING\",\n  \"statement_descriptor\": null,\n  \"subtype\": \"API\",\n  \"supplemental_fee\": null,\n  \"tags\": {},\n  \"tip_amount\": null,\n  \"trace_id\": \"451d044c-410d-54ge-c3b5-ef7c8g4e3358\",\n  \"type\": \"DEBIT\",\n  \"_links\": {\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR4mNhCuXkAqRsDYbJYnBCDe\"\n    },\n    \"merchant_identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR4mNhCuXkAqRsDYbJYnBCDe/payment_instruments\"\n    },\n    \"reversals\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR4mNhCuXkAqRsDYbJYnBCDe/reversals\"\n    },\n    \"fees\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR4mNhCuXkAqRsDYbJYnBCDe/fees\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR4mNhCuXkAqRsDYbJYnBCDe/disputes\"\n    },\n    \"source\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU\"\n    },\n    \"fee_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Pull from Bank (Same Day ACH)","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createTransfer","exampleKey":"Transfer - Me to Me Pull - Bank - Same Day","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/transfers/responses/json/createTransferMeToMePullBankSameDay.jsonc","language":"json","title":"Transfer - Me to Me Pull - Bank - Same Day","header":{"title":"Transfer - Me to Me Pull - Bank - Same Day","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"TR5sDhCuXkAqRsEYbJYnSDFg\",\n  \"created_at\": \"2025-08-15T13:37:30.38Z\",\n  \"updated_at\": \"2025-08-15T13:37:30.38Z\",\n  \"additional_buyer_charges\": null,\n  \"additional_healthcare_data\": null,\n  \"additional_purchase_data\": null,\n  \"address_verification\": null,\n  \"amount\": 15000,\n  \"amount_requested\": 15000,\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"currency\": \"USD\",\n  \"destination\": null,\n  \"externally_funded\": \"UNKNOWN\",\n  \"failure_code\": null,\n  \"failure_message\": null,\n  \"fee\": 0,\n  \"fee_profile\": \"FPmtT4MYmiAs1qjLjneQmk4d\",\n  \"funds_flow_type\": \"ME_TO_ME\",\n  \"idempotency_id\": null,\n  \"merchant\": \"MU2bESfmfedhA2SjcymNvSAX\",\n  \"merchant_identity\": \"IDA3M8ueFuXaJex7N6jcAR9\",\n  \"messages\": [],\n  \"network_details\": null,\n  \"operation_key\": \"PULL_FROM_SAME_DAY_ACH\",\n  \"parent_transfer\": null,\n  \"parent_transfer_trace_id\": null,\n  \"raw\": null,\n  \"ready_to_settle_at\": null,\n  \"receipt_last_printed_at\": null,\n  \"security_code_verification\": null,\n  \"source\": \"PI95jTbyzcdjhWsgFEK6vqSU\",\n  \"split_transfers\": [],\n  \"state\": \"PENDING\",\n  \"statement_descriptor\": null,\n  \"subtype\": \"API\",\n  \"supplemental_fee\": null,\n  \"tags\": {},\n  \"tip_amount\": null,\n  \"trace_id\": \"e8g0515f-49fb-5d99-9012-919ge3dg8bbe\",\n  \"type\": \"DEBIT\",\n  \"_links\": {\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR5sDhCuXkAqRsEYbJYnSDFg\"\n    },\n    \"merchant_identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR5sDhCuXkAqRsEYbJYnSDFg/payment_instruments\"\n    },\n    \"reversals\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR5sDhCuXkAqRsEYbJYnSDFg/reversals\"\n    },\n    \"fees\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR5sDhCuXkAqRsEYbJYnSDFg/fees\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TR5sDhCuXkAqRsEYbJYnSDFg/disputes\"\n    },\n    \"source\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU\"\n    },\n    \"fee_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d\"\n    }\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-8-create-a-payout-transfer","__idx":10},"children":["Step 8: Create a Payout Transfer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the pull transfer has ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]},", create the payout ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Transfer"]}," to push funds to the customer's destination instrument."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create the payout ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Transfer"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment Instrument"]}," ID as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["destination"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["funds_flow_type"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ME_TO_ME"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]},", set the funds to send in cents."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pull_transfer_id"]}," to the ID of the completed transfer used to pull funds from Step 6. The linked ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Transfer"]}," must:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Have an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operation_key"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PULL_FROM_CARD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PULL_FROM_ACH"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PULL_FROM_SAME_DAY_ACH"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCEEDED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Be associated with the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identity"]}," tied to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Payment Instrument"]}," provided in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["destination"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Have the same amount being requested for the Payout transfer"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["It is recommended to include an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idempotency_id"]}," field in the payload. For more information, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/additional-resources/developers/authentication-and-api-basics/idempotent-request"},"children":["Idempotent Requests"]},"."]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Payout to Card","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createTransfer","exampleKey":"Transfer - Me to Me Payout - Card","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/transfers/responses/json/createTransferMeToMePayoutCard.jsonc","language":"json","title":"Transfer - Me to Me Payout - Card","header":{"title":"Transfer - Me to Me Payout - Card","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"TRhJdBnKpQsRmXvWyLzGcFUm\",\n  \"created_at\": \"2025-08-14T21:45:12.98Z\",\n  \"updated_at\": \"2025-08-14T21:45:12.98Z\",\n  \"additional_buyer_charges\": null,\n  \"additional_healthcare_data\": null,\n  \"additional_purchase_data\": null,\n  \"address_verification\": null,\n  \"amount\": 15000,\n  \"amount_requested\": 15000,\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"currency\": \"USD\",\n  \"destination\": \"PIveyqg2bVkKo6SHsstxBSDc\",\n  \"externally_funded\": \"UNKNOWN\",\n  \"failure_code\": null,\n  \"failure_message\": null,\n  \"fee\": 0,\n  \"fee_profile\": \"FPmtT4MYmiAs1qjLjneQmk4d\",\n  \"funds_flow_type\": \"ME_TO_ME\",\n  \"idempotency_id\": null,\n  \"merchant\": \"MUuNdhs7uVYcjocWugeBbpRo\",\n  \"merchant_identity\": \"IDbPrApp2adDVqG4QQzoo58E\",\n  \"messages\": [],\n  \"network_details\": {},\n  \"operation_key\": \"PUSH_TO_CARD\",\n  \"parent_transfer\": null,\n  \"parent_transfer_trace_id\": null,\n  \"pull_transfer_id\": \"TR3vKfwCuXmLqPsDYbGYn4NUm\",\n  \"raw\": null,\n  \"ready_to_settle_at\": null,\n  \"receipt_last_printed_at\": null,\n  \"security_code_verification\": null,\n  \"source\": null,\n  \"split_transfers\": [],\n  \"state\": \"SUCCEEDED\",\n  \"statement_descriptor\": null,\n  \"subtype\": \"API\",\n  \"supplemental_fee\": null,\n  \"tags\": {},\n  \"tip_amount\": null,\n  \"trace_id\": \"91850fg7-3129-6216-c5hh-h795f9h5g569\",\n  \"type\": \"CREDIT\",\n  \"_links\": {\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm\"\n    },\n    \"merchant_identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDbPrApp2adDVqG4QQzoo58E\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm/payment_instruments\"\n    },\n    \"reversals\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm/reversals\"\n    },\n    \"fees\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fees?linked_to=TRhJdBnKpQsRmXvWyLzGcFUm\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm/disputes\"\n    },\n    \"destination\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PIveyqg2bVkKo6SHsstxBSDc\"\n    },\n    \"fee_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Payout to Bank (Next Day ACH)","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createTransfer","exampleKey":"Transfer - Me to Me Payout - Bank","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/transfers/responses/json/createTransferMeToMePayoutBank.jsonc","language":"json","title":"Transfer - Me to Me Payout - Bank","header":{"title":"Transfer - Me to Me Payout - Bank","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"TRkPvQmNxBsHdWyCjLzGaFRp\",\n  \"created_at\": \"2025-08-14T20:59:09.39Z\",\n  \"updated_at\": \"2025-08-14T20:59:09.39Z\",\n  \"additional_buyer_charges\": null,\n  \"additional_healthcare_data\": null,\n  \"additional_purchase_data\": null,\n  \"address_verification\": null,\n  \"amount\": 15000,\n  \"amount_requested\": 15000,\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"currency\": \"USD\",\n  \"destination\": \"PI95jTbyzcdjhWsgFEK6vqSU\",\n  \"externally_funded\": \"UNKNOWN\",\n  \"failure_code\": null,\n  \"failure_message\": null,\n  \"fee\": 0,\n  \"fee_profile\": \"FPmtT4MYmiAs1qjLjneQmk4d\",\n  \"funds_flow_type\": \"ME_TO_ME\",\n  \"idempotency_id\": null,\n  \"merchant\": \"MU2bESfmfedhA2SjcymNvSAX\",\n  \"merchant_identity\": \"IDA3M8ueFuXaJex7N6jcAR9\",\n  \"messages\": [],\n  \"network_details\": {},\n  \"operation_key\": \"PUSH_TO_ACH\",\n  \"parent_transfer\": null,\n  \"parent_transfer_trace_id\": null,\n  \"pull_transfer_id\": \"TR4mNhCuXkAqRsDYbJYnBCDe\",\n  \"raw\": null,\n  \"ready_to_settle_at\": null,\n  \"receipt_last_printed_at\": null,\n  \"security_code_verification\": null,\n  \"source\": null,\n  \"split_transfers\": [],\n  \"state\": \"PENDING\",\n  \"statement_descriptor\": null,\n  \"subtype\": \"API\",\n  \"supplemental_fee\": null,\n  \"tags\": {},\n  \"tip_amount\": null,\n  \"trace_id\": \"562e155d-521e-65hf-d4c6-fg8d9h5f4469\",\n  \"type\": \"CREDIT\",\n  \"_links\": {\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp\"\n    },\n    \"merchant_identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp/payment_instruments\"\n    },\n    \"reversals\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp/reversals\"\n    },\n    \"fees\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fees?linked_to=TRkPvQmNxBsHdWyCjLzGaFRp\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp/disputes\"\n    },\n    \"destination\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU\"\n    },\n    \"fee_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d\"\n    }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Payout to Bank (Same Day ACH)","disable":false},"children":[{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-api/index.yaml","operationId":"createTransfer","exampleKey":"Transfer - Me to Me Payout - Bank - Same Day","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../api/components/examples/transfers/responses/json/createTransferMeToMePayoutBankSameDay.jsonc","language":"json","title":"Transfer - Me to Me Payout - Bank - Same Day","header":{"title":"Transfer - Me to Me Payout - Bank - Same Day","controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"TRnRtQmNxBsHdWyCjLzGaFSd\",\n  \"created_at\": \"2025-08-15T13:37:30.38Z\",\n  \"updated_at\": \"2025-08-15T13:37:30.38Z\",\n  \"additional_buyer_charges\": null,\n  \"additional_healthcare_data\": null,\n  \"additional_purchase_data\": null,\n  \"address_verification\": null,\n  \"amount\": 15000,\n  \"amount_requested\": 15000,\n  \"application\": \"APc9vhYcPsRuTSpKD9KpMtPe\",\n  \"currency\": \"USD\",\n  \"destination\": \"PI95jTbyzcdjhWsgFEK6vqSU\",\n  \"externally_funded\": \"UNKNOWN\",\n  \"failure_code\": null,\n  \"failure_message\": null,\n  \"fee\": 0,\n  \"fee_profile\": \"FPmtT4MYmiAs1qjLjneQmk4d\",\n  \"funds_flow_type\": \"ME_TO_ME\",\n  \"idempotency_id\": null,\n  \"merchant\": \"MU2bESfmfedhA2SjcymNvSAX\",\n  \"merchant_identity\": \"IDA3M8ueFuXaJex7N6jcAR9\",\n  \"messages\": [],\n  \"network_details\": null,\n  \"operation_key\": \"PUSH_TO_SAME_DAY_ACH\",\n  \"parent_transfer\": null,\n  \"parent_transfer_trace_id\": null,\n  \"pull_transfer_id\": \"TR5sDhCuXkAqRsEYbJYnSDFg\",\n  \"raw\": null,\n  \"ready_to_settle_at\": null,\n  \"receipt_last_printed_at\": null,\n  \"security_code_verification\": null,\n  \"source\": null,\n  \"split_transfers\": [],\n  \"state\": \"PENDING\",\n  \"statement_descriptor\": null,\n  \"subtype\": \"API\",\n  \"supplemental_fee\": null,\n  \"tags\": {},\n  \"tip_amount\": null,\n  \"trace_id\": \"f9h1626g-60gc-6e00-0123-020hf4eh9ccf\",\n  \"type\": \"CREDIT\",\n  \"_links\": {\n    \"application\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe\"\n    },\n    \"self\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd\"\n    },\n    \"merchant_identity\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9\"\n    },\n    \"payment_instruments\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd/payment_instruments\"\n    },\n    \"reversals\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd/reversals\"\n    },\n    \"fees\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fees?linked_to=TRnRtQmNxBsHdWyCjLzGaFSd\"\n    },\n    \"disputes\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd/disputes\"\n    },\n    \"destination\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU\"\n    },\n    \"fee_profile\": {\n      \"href\": \"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d\"\n    }\n  }\n}\n"},"children":[]}]}]}]},"headings":[{"value":"Me to Me Payouts","id":"me-to-me-payouts","depth":1},{"value":"Step 1: Create an Identity","id":"step-1-create-an-identity","depth":2},{"value":"Required Data","id":"required-data","depth":3},{"value":"API Request","id":"api-request","depth":3},{"value":"Step 2: Add a Source Payment Instrument","id":"step-2-add-a-source-payment-instrument","depth":2},{"value":"Step 3: (Optional) Verify the Source Payment Instrument","id":"step-3-optional-verify-the-source-payment-instrument","depth":2},{"value":"Step 4: Add a Destination Payment Instrument","id":"step-4-add-a-destination-payment-instrument","depth":2},{"value":"Step 5: (Optional) Verify the Destination Payment Instrument","id":"step-5-optional-verify-the-destination-payment-instrument","depth":2},{"value":"Step 6: Verify and Onboard the Account","id":"step-6-verify-and-onboard-the-account","depth":2},{"value":"Step 7: Create a Transfer to Pull Funds","id":"step-7-create-a-transfer-to-pull-funds","depth":2},{"value":"Step 8: Create a Payout Transfer","id":"step-8-create-a-payout-transfer","depth":2}],"frontmatter":{"seo":{"title":"Me to Me Payouts","description":"Move funds between a customer's own accounts using Finix Me to Me payouts. Pull from a card or bank account and push to a debit or credit card.","image":"/images/og-images/guides-payouts-me-to-me-payouts.png"},"keywords":{"includes":["me to me","me-to-me","me to me payout","pull from card","pull from ach","pull transfer","funds flow","payout","recipient","send money"],"excludes":["idempotency","idempotent","identity","merchant","payment instrument","PCI","token","transfer","verification"]}},"lastModified":"2026-04-17T03:16:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/payouts/me-to-me-payouts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}