{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-platform/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Validations","siteUrl":"https://docs.glomo.one","llmstxt":{"title":"Glomo developer documentation","description":"Cross-border payments APIs, organised by product. Each product section carries both the explanation of its objects and the job-shaped integration guides that set them up.","details":{"content":"How to use these docs:\n\n- Get started is the front door. It has one section per integration\n  (what you're building), each with the API calls in order and the guide that builds it, plus\n  how to get API keys.\n- The product sections - Payin, Payout, Multi-currency accounts,\n  Verification, Request for Information (RFI) - each hold two kinds of page.\n  Pages titled as a noun (\"Subscriptions\", \"Bank Transfer\") explain what\n  an object is. Pages titled as a job (\"Set up recurring subscriptions\",\n  \"Collect LRS remittances from India\") are complete integration flows\n  and live one level under the object they set up. Match a user's goal\n  against the job-shaped titles first.\n- Reports and Identity and Access Management are the two subjects with no\n  API counterpart. There are no endpoints for reports, users, roles or\n  invites; both pages document the merchant dashboard. A dashboard\n  procedure for something the API also does (a refund, a payout) is NOT\n  here - it stays in the product that owns it.\n- API reference is generated from OpenAPI and carries endpoint detail.\n- The OpenAPI description itself is published as a single self-contained\n  document at /openapi.yaml, and the same document as JSON at\n  /openapi.json. Every $ref is resolved into it, so one fetch is the\n  whole contract: 61 paths, 81 operations, 68 schemas - the same\n  endpoints the API reference pages render. Fetch that instead of\n  reading the 129 pages under /api-reference/.\n- Every page below, in full, is one document at /llms-full.txt. Fetch that\n  instead of the pages one by one. It leaves out the API reference;\n  /openapi.yaml is that.\n- Developer resources covers what every integration touches and no single\n  product owns: auth, errors, pagination, rate limits, webhooks,\n  versioning, supported countries, quotes, the MCP server for AI\n  agents, and the client SDKs.\n"},"sections":[{"title":"Get started","description":"The front door. The ordered API calls for each integration and the guide that delivers it, how to obtain API keys, and the platform glossary.","includeFiles":["**/get-started/**"]},{"title":"Payin","description":"Collecting money: customers, orders, checkout, payment links, payment methods (cards, bank transfer, pay via bank), refunds, disputes, purpose codes, fee models, custom fields, subscriptions, and resident India remittance under LRS. Includes the flows that set each up - bank transfers, subscriptions, LRS remittances, and server-to-server card payments.","includeFiles":["**/payin/**"]},{"title":"Payout","description":"Sending money: the payout life cycle, queued payouts, creating and cancelling a payout, rails, beneficiaries, purpose codes, and the action required state. Includes the flow that sends a payout over the API.","includeFiles":["**/payout/**"]},{"title":"Multi-currency accounts","description":"Holding money: balances, balance conversion, adding balance, and withdrawing balance.","includeFiles":["**/multi-currency-account/**"]},{"title":"Verification","description":"Proving who someone is and that an account is theirs: KYC, bank account validation, and third-party verification (TPV) with the flow that verifies a payer's bank account.","includeFiles":["**/verification/**"]},{"title":"Request for Information (RFI)","description":"Responding to a compliance request for information, per object - payment link, order, payment, payout - plus compliance reviews and RFIs raised on already-successful payments.","includeFiles":["**/request-for-information/**"]},{"title":"Nivo (Capital markets)","description":"Nivo, Glomo's capital markets suite (Nivo for AMCs, Nivo for Distributors, and overseas investing for brokers and wealth platforms). Mutual fund investments run as payment sessions: the fund, distributor, scheme, plan, ARN and folio roles; the distributor's relationship with a fund and what it fixes; and the flow that opens a session as a distributor.","includeFiles":["**/capital-markets/**"]},{"title":"Reports","description":"The downloadable and scheduled reports a merchant pulls from the dashboard for reconciliation, compliance and treasury: payment, subscription, settlement breakup, balance statement and KYC reports, plus scheduling one for recurring email delivery and customizing the fields and column order of a report. Dashboard only - there is no reports API.","includeFiles":["**/reports/**"]},{"title":"Identity and Access Management","description":"Administering who can use a merchant account: one set of credentials across multiple MIDs, switching between them without logging out, the Admin / Member / Sales Partner roles and what each may see and do, and inviting a new member. Dashboard only - there is no users, roles or invites API.","includeFiles":["**/access-management/**"]},{"title":"Settlement holidays","description":"The settlement holiday calendar for 2026 - the Indian and US bank and FX holidays on which payin, payout and settlement to the merchant's bank account may be delayed.","includeFiles":["**/settlement-holidays/**"]},{"title":"API reference","description":"Endpoint reference generated from the Glomo OpenAPI description.","includeFiles":["**/api-reference/**"]},{"title":"Developer resources","description":"What every integration touches and no single product owns: auth, errors, pagination, rate limits, webhooks, versioning, API validations, security, supported countries, quotes, connecting an AI agent to the Glomo MCP server, and the client SDKs - React Native, Flutter, Android and the Unified Web SDK, with per-version references and changelogs. Reports and Identity and Access Management used to be listed here and are now their own sections.","includeFiles":["**/platform/**"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-validations","__idx":0},"children":["API Validations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Glomo APIs apply comprehensive business logic validations to ensure that every request aligns with product rules, regulatory standards, and expected workflows. These validations go beyond simple formatting checks and focus on the correctness, consistency, and legitimacy of the transaction itself. By enforcing these rules, Glomo guarantees that only valid operations are processed, while any invalid request is immediately rejected with a clear and standardized error response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-creating-customers","__idx":1},"children":["Validations for creating customers"]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer name cannot be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer Type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Anything other than Individual or Business"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer type must be either Individual or Business."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address is not valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Already used in your business"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This email address is already registered under your business."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format (if provided)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone number format is invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address cannot be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City cannot be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State cannot be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong code (not 3-letter, lowercase, or unsupported)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country code must be a valid 3-letter ISO code (e.g., IND, USA)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pincode"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing for countries where it is mandatory"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pincode is required for the selected country."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nationality"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong code (not valid 3-letter ISO)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nationality code must be valid 3-letter ISO."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date of Birth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Future date or wrong format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date of birth must be in the past."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Duplicate Customer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email already exists in the system"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A customer with this email already exists."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," By default, customer uniqueness is enforced on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["email"]}," — a business cannot create two customers with the same email. On the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/payin/resident-india-remittance-under-lrs"},"children":["LRS"]}," flow, this can instead be enforced on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PAN"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tax_identification_number"]},") in place of email, so customers are de-duplicated by PAN even if they use different emails. This is off by default — to enable it for your account, reach out to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:support@glomopay.com"},"children":["support@glomopay.com"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-updating-customers","__idx":2},"children":["Validations for updating customers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applies to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /customer/{id}"]},". Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phone"]}," can be updated, and the update is partial — omitted fields are left unchanged."]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing, empty, or wrong format (must start with cust_)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID must start with cust_ and be valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Neither ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," nor ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phone"]}," supplied"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["At least one field must be provided to update."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supplied but blank or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email can't be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address is not valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supplied but blank or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone can't be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not a valid number for the customer's country"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone number format is invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID doesn't exist in your account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer not found."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For account funding partners:"]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sent without the other address fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address can't be blank."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last KYC date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}," date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Kyc last_kyc_date must be a date in YYYY-MM-DD format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last KYC date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["In the future"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Kyc last_kyc_date cannot be in the future."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last KYC date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Earlier than the date already on file"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["last_kyc_date cannot be earlier than the KYC date on file."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last KYC date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer was created without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kyc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Kyc last_kyc_date can only be updated for a customer onboarded with partner KYC."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-creating-orders","__idx":3},"children":["Validations for creating orders"]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing, empty, or wrong format (must start with cust_)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID must start with cust_ and be valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero, negative, or non-integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount must be a positive whole number in the smallest currency unit (e.g., cents)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not supported or not uppercase 3-letter code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency code must be valid (USD, EUR, GBP, AED, SGD)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format (must start with doc_)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document ID must start with doc_ and be valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or not found in the system"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose code is not valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero or negative"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice amount must be greater than 0."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains unsupported characters or too long (>50 chars)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice number contains invalid characters or is too long."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice Description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains unsupported characters or too long (>512 chars)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice description contains invalid characters or is too long."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product (Name/Description)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name missing, invalid characters, or too long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product name is required, valid characters only, max 128 chars."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notes / Reference Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format (rare)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notes or reference number is invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Duplicate Order"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order already exists"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An order with these details already exists."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID doesn't exist in your account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer not found."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-creating-payment-links","__idx":4},"children":["Validations for creating payment links"]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing, empty, or wrong format (must start with cust_)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID must start with cust_ and be valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero, negative, or non-integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The amount must be a positive whole number in the smallest currency unit (e.g., cents)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not supported or not uppercase 3-letter code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency code must be valid (USD, EUR, GBP, AED, SGD)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or missing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose code is not valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expires At"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Past date, wrong format, or more than 6 months ahead"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expiry date must be in the future and within 6 months."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format (must start with doc_)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document ID must start with doc_ and be valid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero or negative"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice amount must be greater than 0."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains unsupported characters or too long (>50 chars)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice number contains invalid characters or is too long."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice Description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains unsupported characters or too long (>512 chars)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice description contains invalid characters or is too long."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reminder Frequency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value not in [1, 2, 7, 14]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reminder frequency must be 1, 2, 7, or 14 days."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product (Name/Description)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name missing, invalid characters, or too long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Product name is required, valid characters only, max 128 chars."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format (rare)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference number is invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer ID doesn't exist in your account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer not found."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document ID doesn't exist in your account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document not found."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Duplicate Payment Link"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link already exists"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A payment link with these details already exists."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-declaring-dynamic-fee-splits","__idx":5},"children":["Validations for declaring dynamic fee splits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applies to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /prices/dynamic-splits"]},". List the rules you may declare against with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /prices/dynamic"]},"."]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price id can't be blank"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong format (must start with price_)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price id must start with 'price_' and contain only alphanumeric characters"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Does not exist, or belongs to another business"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["price_id not found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The rule's fee bearer is not dynamic"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["price_id is not a dynamic-bearer rule"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The rule does not price a payin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["dynamic splits are only supported for payin"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The rule does not price transaction fees"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["dynamic splits are only supported for transaction_fees"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The rule version is not effective yet"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["price_id is not effective yet"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A newer version of the rule is effective"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["price_id has been superseded by a newer version of the rule"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bps / fixed_amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Neither provided, or both provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["exactly one of bps or fixed_amount must be provided"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bps"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing on a percentage-priced rule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bps is required for a percentage-priced rule"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bps"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greater than the rule's own bps"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["bps cannot exceed the rule's total of 300"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fixed_amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing on a fixed-priced rule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fixed_amount is required for a fixed-priced rule"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fixed_amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greater than the rule's own fees_amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fixed_amount cannot exceed the rule's total"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fee_currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Does not match a fixed-priced rule's currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fee_currency must be USD to match the rule"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fee_currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing while min_fee or max_fee is declared"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fee_currency is required when a bound is declared"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["min_fee / max_fee"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declared on a fixed-priced rule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["min_fee and max_fee are not supported for a fixed-priced rule"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["min_fee / max_fee"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["min_fee greater than max_fee"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["min_fee must be less than or equal to max_fee"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Any amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not an integer, or negative"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bps must be an integer / Bps must be greater than or equal to 0"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," All amounts are in minor units (cents) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bps"]}," is basis points, so 100 is 1%. A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bps"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}," is valid and means the customer bears the whole fee. Each rule is held to its own ceiling — a declaration against one rule is never capped by another rule's total."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-using-split_ids","__idx":6},"children":["Validations for using split_ids"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applies to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /payin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /orders"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /quotes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /subscriptions"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /payment"]},". Messages raised by form validation arrive prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Validation failed: "]},"."]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An id does not exist, belongs to another business, or no longer points at a live dynamic rule"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids are invalid or no longer point at a dynamic rule: psplit_7Kq2mXbTdLp9"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Two dynamic rules share a dimension and only one is declared"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids must be declared for every dynamic rule on the dimension, missing rules: price_Kd82nvQ1TzAe"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A declared payment method is not enabled for your business (payment links and orders only)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids are not valid for any enabled payment method: bank_transfer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omitted while your account requires a declaration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids are required when dynamic fee splits are enforced"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sent with a quote_id on a payment link or an order"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids cannot be specified when quote_id is present"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sent on a quote whose resource is not payin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids is only valid for payin quotes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sent on a fixed-frequency subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids are only supported for as_presented subscriptions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sent on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /payment"]}," for a fixed-frequency subscription"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids are only supported for as_presented subscriptions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Omitted on an auto debit whose subscription declaration no longer resolves"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declared fee splits on the subscription no longer point at a live dynamic rule: psplit_7Kq2mXbTdLp9. Pass a valid split_id to override."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declared for a payment method a subscription never charges (only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pay_via_bank"]}," are chargeable)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Split ids cannot be declared for a payment method a subscription never charges: bank_transfer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sent on an auto debit for a method other than the one the subscription charges"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["split_ids must be declared for card, which this subscription charges, not bank_transfer"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," A dimension is the combination of payment method, subtype, rail, currency and fee type. When two dynamic rules share one, declare a split for both."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," A subscription only ever charges ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pay_via_bank"]}," when SEPA-eligible, so a split declared for any other payment method is rejected both at subscription creation and on an auto debit. An auto-debit override must be declared for the method the subscription actually charges."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["split_ids"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_methods"]}," are independent. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payment_methods"]}," restricts which methods the checkout offers; a split only changes how the fee for its own payment method is priced. One checkout can price one method from a dynamic split and another method from your normal rules."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," If a payment link or an order carries a declaration that no longer resolves, opening the checkout returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["This payment_link has expired because of expired split_ids. Please create another payin."]}," (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["This orders has expired…"]}," for an order). The payin is expired and you must issue a new one."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"validations-for-creating-beneficiaries-v2","__idx":7},"children":["Validations for creating beneficiaries (v2)"]},{"$$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":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What Can Go Wrong"},"children":["What Can Go Wrong"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Error Message You'll See"},"children":["Error Message You'll See"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category can't be blank"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not \"lrs\" or \"payout\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Category must be one of: lrs, payout"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary can't be blank"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not an object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary must be an object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary Name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary name is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary Address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary address is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account can't be blank"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not an object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account must be an object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account account_number is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank Name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account name is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account swift_code is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not 8-11 characters (payout category)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift code must be 8 to 11 characters long"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not exactly 8 characters (LRS category)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift code must be 8 characters long"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First 6 characters not alphabets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift code First 6 characters must be alphabets"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SWIFT Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country code doesn't match bank address country"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Swift code Country code in BIC does not match selected country"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account currency is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank Address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or blank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account address is required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Local Routing Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing for LRS category"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Local routing number can't be blank"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Intermediate Bank"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provided but not an object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account intermediate_bank must be an object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Intermediate Bank SWIFT Code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing for LRS category"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bank account intermediate_bank swift_code is required for LRS beneficiaries"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Duplicate Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account already exists for this business"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business already had this Account Number, Account Type and Transfer Method"]}]}]}]}]}]},"headings":[{"value":"API Validations","id":"api-validations","depth":1},{"value":"Validations for creating customers","id":"validations-for-creating-customers","depth":2},{"value":"Validations for updating customers","id":"validations-for-updating-customers","depth":2},{"value":"Validations for creating orders","id":"validations-for-creating-orders","depth":2},{"value":"Validations for creating payment links","id":"validations-for-creating-payment-links","depth":2},{"value":"Validations for declaring dynamic fee splits","id":"validations-for-declaring-dynamic-fee-splits","depth":2},{"value":"Validations for using split_ids","id":"validations-for-using-split_ids","depth":2},{"value":"Validations for creating beneficiaries (v2)","id":"validations-for-creating-beneficiaries-v2","depth":2}],"frontmatter":{"seo":{"title":"API Validations"}},"lastModified":"2026-11-06T11:06:03.698Z","pagePropGetterError":{"message":"","name":""}},"slug":"/platform/validations","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}