{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Setting Up Autopay","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"setting-up-autopay","__idx":0},"children":["Setting Up Autopay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide explains how to set up autopay for borrower loans. You'll learn to create payment methods, manage autopay agreements, and establish automatic payments through a step-by-step process."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Autopay API enables programmatic, recurring loan payments in Peach implementations. The process is divided into three main stages:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Creating a Payment Instrument"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Handling the Autopay Agreement Document"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Finalizing the Autopay Configuration"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration-options","__idx":2},"children":["Configuration Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When finalizing autopay setup, you have several configuration options:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountType"]}," : Determines what amount will be automatically paid"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statementBalanceAmount"]}," : Pay the full statement balance"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statementMinimumAmount"]}," : Pay only the minimum amount due"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isAlignedToDueDates"]}," : When true, autopay dates will match the loan's due dates"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offsetFromDueDate"]}," : Number of days before/after the due date to process the payment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":3},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before starting, ensure the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have a Peach account with API access."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API credentials are ready."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A borrower record already exists."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":4},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include your API key in the request header for all API calls:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"X-API-KEY: YOUR_API_KEY\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": The following examples use commonly used fields, but for full details, including additional data and parameters, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-docs/api-public"},"children":["API Reference"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"setting-up-autopay-1","__idx":5},"children":["Setting Up Autopay"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1-create-a-payment-instrument","__idx":6},"children":["Step 1: Create a Payment Instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The first step involves creating a payment instrument for automatic payments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /people/{personId}/payment-instruments\nContent-Type: application/json\nX-API-KEY: YOUR_API_KEY\n\n{\n  \"status\": \"active\",\n  \"verified\": true,\n  \"nickname\": \"Bank\",\n  \"instrumentType\": \"bankAccount\",\n  \"accountNumber\": \"12341111\",\n  \"routingNumber\": \"103000648\",\n  \"accountType\": \"checking\",\n  \"accountHolderType\": \"personal\",\n  \"accountHolderName\": \"John Doe\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [{\n    \"accountHolderName\": \"John Doe\",\n    \"accountHolderType\": \"personal\",\n    \"accountNumberLastFour\": \"1234\",\n    \"accountType\": \"checking\",\n    \"companyId\": \"CP-3421-7842\",\n    \"createdAt\": \"2022-09-30T19:18:01.404070+00:00\",\n    \"id\": \"PT-9087-4563\",\n    \"nickname\": \"Bank\",\n    \"status\": \"active\",\n    \"verified\": true\n  }],\n  \"message\": \"Created payment instrument\",\n  \"status\": 201\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentInstrumentId"]},") for later."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2-handle-the-autopay-agreement-document","__idx":7},"children":["Step 2: Handle the Autopay Agreement Document"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Borrowers must accept an autopay agreement before activation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2.1 Create Document Descriptor"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /people/{personId}/documents\nContent-Type: application/json\nX-API-KEY: YOUR_API_KEY\n\n{\n  \"type\": \"loanAutopayAgreement\",\n  \"status\": \"draft\",\n  \"loanId\": \"LN-2348-5679\",\n  \"fileName\": \"LoanAutopayAgreement-LN-2348-5679.html\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"DD-5678-1234\",\n  \"loanId\": \"LN-2348-5679\",\n  \"status\": \"draft\",\n  \"type\": \"loanAutopayAgreement\",\n  \"fileName\": \"LoanAutopayAgreement-LN-2348-5679.html\",\n  \"companyId\": \"CP-3421-7842\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["documentDescriptorId"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},") for later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2.2 Render the Agreement Document"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /communicator/render-to-document?fmt=html\nContent-Type: application/json\nX-API-KEY: YOUR_API_KEY\n\n{\n  \"fmt\": \"pdf\",\n  \"subject\": \"autopayAgreement\",\n  \"documentId\": \"DD-5678-1234\",\n  \"context\": {\n    \"lenderName\": \"Your Lender Name\",\n    \"paymentMethod\": \"bankAccount\",\n    \"paymentMethodLastFour\": \"1234\",\n    \"dateSigned\": \"2024-12-12\"\n  },\n  \"loanId\": \"LN-2348-5679\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2.3 Mark Agreement as Accepted"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"PUT /people/{personId}/documents/{documentDescriptorId}\nContent-Type: application/json\nX-API-KEY: YOUR_API_KEY\n\n{\n  \"status\": \"accepted\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-3-configure-autopay","__idx":8},"children":["Step 3: Configure Autopay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finally, create the autopay configuration using the payment instrument and agreement document:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /people/{personId}/loans/{loanId}/autopay\nContent-Type: application/json\nX-API-KEY: YOUR_API_KEY\n\n{\n  \"previewMode\": false,\n  \"amountType\": \"statementBalanceAmount\",\n  \"isAlignedToDueDates\": true,\n  \"paymentInstrumentId\": \"PT-9087-4563\",\n  \"agreementDocumentId\": \"DD-5678-1234\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"agreementDocumentId\": \"DD-5678-1234\",\n    \"paymentInstrumentId\": \"PT-9087-4563\",\n    \"paymentFrequency\": \"monthly\",\n    \"schedule\": [{\n      \"amount\": 473.78,\n      \"date\": \"2022-10-15\",\n      \"status\": \"booked\"\n    }],\n    \"type\": \"statementBalanceAmount\"\n  },\n  \"status\": 200\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":9},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payments/peach-processing"},"children":["Peach Processing"]}]}," — Configure Peach as your payment processor before enabling autopay."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payments"},"children":["Payment Processing Overview"]}]}," — Index of payment processing options and concepts."]}]}]},"headings":[{"value":"Setting Up Autopay","id":"setting-up-autopay","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Configuration Options","id":"configuration-options","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Setting Up Autopay","id":"setting-up-autopay-1","depth":2},{"value":"Step 1: Create a Payment Instrument","id":"step-1-create-a-payment-instrument","depth":3},{"value":"Step 2: Handle the Autopay Agreement Document","id":"step-2-handle-the-autopay-agreement-document","depth":3},{"value":"Step 3: Configure Autopay","id":"step-3-configure-autopay","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Setting Up Autopay"}},"lastModified":"2026-05-01T14:33:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/payments/autopay","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}