feat: add payout docs

docs/api/financial/create-payout.api.mdx

@@ -0,0 +1,75 @@
+---
+id: create-payout
+title: "Create payout"
+description: "    Create a new payout for the Account."
+sidebar_label: "Create payout"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWu1T2zwS/1c0em7mmblLwHFeCPl0IUBLCzQlwLXlYYJibxKBLRlJDoRM/vcbSXYSkuA4117vPvCldcxqd7WrffmtNcGKDCRu3OA2GfNYSXxbwD5IT9BIUc5wAyOEUEsAUYAIYvCEIkOJ+lwgNQTU9DweM7XzF/uLado//vgDtUGEVErKmbQv/47ulCBMEk9zbTwJquAOFzCPQBD96sTHDZyIsQJwAQt4jEGqA+6PcWOCPc4UMKUfSRQF1DMrd++l1nOCpTeEkOgnvY4K8PW+SKi1wwUckXEITHVDUEPu632qcQS4gXnvHjxDIbQ6ioLUTOBZgWAk6FJf/wzJ8ymwgRriRslxZoulEpQN8LLRrDXRySGiDIUgvCFh6k+J5FgqCHEBszgISC8A3FAihgKGZxJG+icuubW6B9VakVR61WKl3CfFetWtFUnVcfqeW6o4vR6eFtKNadUoo2Ec4oaj+XhBLOkIztKXln+iLmUKBiBW9G0aZoj3jUsTD1OGPGBK7qCS4ziISvS3krPjOLiA+1yERFmGtQpe0F+TTgvYi4UA5o2XTFcuaG0XfmWbsYy8IRHEUyDQSecLSrkij/uQacWrzqE20pLTG5MNTveIWKR627uaKzLUy1pMC7hH2EOX2LjIz02vQumqFa7a475P9RoStBeU7pNAagdTZTaecDszG76wAYSNQ6TiIYjNNqA5LNBKuKGTw0w3eLHs7jXH1dC7+tZ8fhLntaevR1+vro8+HrQ+abWWoiy31O3jCvb296Bf9oq9ar1WrJTL5SLp7zvFvVKt7tcr7p5fr2qNerGkDKTsMhLCZp3OSQhp3KRLEe3Pn1PDI8MnS8PmE0geAmrxMCJsXECnpy2tUZ8KqXKqc6xpEVtQKgIhOdMqJU/5FfrEh0wrEJDc8k/JrxPfCakamkMSEhpsln2kyRDxfQFSZnK+50O2IzX7fxreOx4PTboYcpZjk21Nhlgc9kwqfVvOP0rVarVSd/fLlT2cO4Qv55UyPfHmYNIgoGzQ9UERGsiVQmf33Q0og24JF7BH1Vj/p/OJ0E8Rl4oE3SR3SkUUbC6DS2xfp3O36rxK6KVNCb2jBIA9IPhV0SuVUIsHXBCfo+YIdrA11ly0u050trBmpAqoE1MFiAvU/oIO+HN2AEYKVZyySZfaeGvK/jabbVkHzPkfgkRnXKcFLcI6IKs+upskuHpjy0XS8E0r5Fz4SdOc8IUzsCR6y921DSetwAuNVsVVS6VSyVgyOX9L7ttOmLvcCFimq2KvOvnjrJlkitwLbH9qe7tZadWr53GYdAACZMSZtCHkOiZulg6H4eWbAM3Z1v582Z61pZlhEI1V162cH7f98n3nx/HlMyUf96+e7uPHc79tAtM2KblqdgIPNskkntc9qJbqjH54+vD98wsd1EZKXFz/+PDhw7WpAWxEBWch5GmpjubEqIhahKEeoDsFUt3pA3sXCe7HJsHeZVtiRrd1r/IbEIAO9FjmViUhz5IsY88DKftxoPn74OnU63cFkOQwZgs6tAtQQp8lqUWEjwIu1a5UPABj3wWEmMvEC3Vy0/FS4rlb+zoIv718fXkod6qfq0fyonzYP6JnF/ev0dTPIKVMZLRfXUFG/9/o5+cSjQk+C0M2ogQi/G69Te4v2eG1GNGjT/WX758Om6fHX8OqRS9E+EMe+CBy9qGt2YK02chuc9Gs2dTNbiVno1tBPh1QJdPjsBYQLoqquBXXppKoG3Kma1+enSB4jqgdlCC7LDt/pCLGQMT2EsyqLAGu41YtMGEDEJGgeXLy8Zx40VxIcUR9YIr2xyhm9DEGtql9b7Xcb6Mx50P2CN7RY0WUj9W3Ue3Mbz1XLnvkX6Wrq0u/1Tqvnp2fms5ZEJYHXmp1LG2W9BGVxKSMkZz1URtq4HVnc8x+N+d8NHK7AqIgR3poXV+7yNJm8T3L398kUavtgN8eY/y2tNAj2bODtA3ZKjGk/chHmxzOcyWHQw5rBFpBOQVaeZfjCBY6Esp8OqJ+TALbl3gW+Wc3JfNFizptpcySGt4QvAfKBlYJSUaUDeQ2SggeKw1NE0i8UY0LS4/ON0PokluuVGt79f3FzVo53Z9J1QmrPCi+5Ggks2UQHRD2kFh7UfMeCQjzYHM4/S967Jl5t4qkjSF0CVItDbW2NGYi6iAx3rbLX81E34eh78PQ92Ho+zD0fRj6Pgx9H4auDkML2LOjyS7JgeoOkw/2pq1/IhJ5s7nmbBLiEwVFRTd0Ca7jVopOrVh2Lp1Sw3Eb7v6OW3J/aI1C7tM+/U9VSlf/Sp226ED0XYapGRNXHGd1EHxAfJQOk3/ZMBiE4EKuo1uv9YyOCEF0nFIF4ZrRot7Fyufut6DHKqE1Sg7KldHmfBy3OGAru+sW25qQSw5lUi31428Rv+nxyXxn+JoE1DcuawveCyA8TOpTegDWfAm4YiRWQy7oy6/8HPDulHkMrndFedUVx1z0qO8De/fD7/NDZdUP51yhYx6z93j4TX7QuwEvFqbRu5ngZkQ/g37EK9f28O30toDTTwqmhzK363Trgnej5Bqh5idGoGvQzQTHIsANPFQqko3dXRLRnSjuBdSTjzERYAHH7VyFjvapdVuqyLxA2Rcr7W2SQu0EuzdGzfYJ+gxjRJmkvv4kZSrsnxJ9KzbbJ8XPR9/REIhvMYtBc3j2F13/NNOEQFtHH7eL+XXEo7RFWLonmO/b3fxzk74tt/hJyHy5Wffhxn6amfv99Wx2Vp5fjzaMRtlTh6WhQ77BwMpcYD1afw3WLYB+hZ8TUDvDtOuh6AyJLiHItSBwGaGtAVOrWGqGdVKoswhOZthEg4YlzJA09gt9fdpzU9bn5tSmMWfOe8ecd5TMo6Q+pLiAdZjYUzwqpbAkJCa7JXZavhj76uwvXIz9717WTSJQwbPajQJCzTjEhPYkif8bHM2vEQ91Zmjc4MmkRyRciWA61a8fY9CGurkt4BER1Cavm9tpIQ03nTAedMzjlt1X8dIOR0YkiG0KWCoD00K6oul5EKlM2sXk1f7SudSnOblgHFqnCvKkLx+TJ9zA5o6yXm1HDPrdBAeEDWIyMMMTw9Pk3fjV1zwS0QeTp5IHvav0T2y8oOFi1rGb0P/qLa0ln0xsBpxOZ/T2T2+umKU5S63ddjudTv8Nt0+0AQ==
+sidebar_class_name: "post api-method"
+info_path: api/financial/publicsquare-payments-api
+custom_edit_url: null
+show_extensions: true
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Create payout"}
+>
+</Heading>
+
+<MethodEndpoint
+  method={"post"}
+  path={"/payouts"}
+  context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+    Create a new payout for the Account.
+
+    ### Permissions
+    * `transaction:write`
+
+<Heading
+  id={"request"}
+  as={"h2"}
+  className={"openapi-tabs__heading"}
+  children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+  parameters={undefined}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+  title={"Body"}
+  body={{"content":{"application/json":{"schema":{"required":["amount","payment_method"],"type":"object","properties":{"external_id":{"maxLength":100,"type":"string","description":"Payout ID in merchant's system","nullable":true,"example":"1268ce56-a4b5-43fa-8526-a500fc2140bb"},"amount":{"minimum":0,"exclusiveMinimum":true,"type":"integer","description":"Amount of the payout in cents. 1000 is $10.00","format":"int64","example":1000},"currency":{"maxLength":3,"minLength":3,"type":"string","description":"3 character ISO currency code","nullable":true,"example":"USD"},"payment_method":{"type":"object","properties":{"card":{"type":"string","description":"Payment card","nullable":true},"bank_account":{"type":"string","description":"Payment bank account","nullable":true}},"additionalProperties":false,"title":"PaymentMethodRequest"},"customer":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID","nullable":true,"example":"cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ"},"external_id":{"type":"string","description":"Customer ID in merchant's system","nullable":true,"example":"e797ef3c-b586-4333-af90-7168d8427d85"},"business_name":{"type":"string","description":"Name of the business if business customer type","nullable":true,"example":"Awesome Company, LLC"},"first_name":{"type":"string","description":"First name of the person if person customer type","nullable":true,"example":"John"},"last_name":{"type":"string","description":"Last name of the person if person customer type","nullable":true,"example":"Smith"},"email":{"type":"string","description":"Email address","nullable":true,"example":"john.smith@email.com"},"phone":{"type":"string","description":"Phone number","nullable":true,"example":"+15554829347"}},"additionalProperties":false,"title":"TransactionCustomer"},"billing_details":{"required":["address_line_1","city","country","postal_code","state"],"type":"object","properties":{"address_line_1":{"maxLength":250,"minLength":1,"type":"string","description":"Street name","example":"111 Colorado Ave."},"address_line_2":{"maxLength":250,"type":"string","description":"Apt, Suite or PO Box","nullable":true,"example":"Apt 403"},"city":{"maxLength":100,"minLength":1,"type":"string","description":"City","example":"Des Moines"},"state":{"maxLength":3,"minLength":2,"type":"string","description":"2 or 3 character ISO state code","example":"IA"},"postal_code":{"maxLength":30,"minLength":1,"type":"string","description":"Postal or zip code","example":"51111"},"country":{"maxLength":2,"minLength":1,"type":"string","description":"2 character ISO country code","example":"US"}},"additionalProperties":false,"title":"Address"}},"additionalProperties":false,"title":"CreatePayoutRequest"}}},"required":true}}
+>
+
+</RequestSchema>
+
+<StatusCodes
+  id={undefined}
+  label={undefined}
+  responses={{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Payout ID","nullable":true,"example":"pyt_24NFPd3jSZFTxiaH9UwjuqNdP"},"account_id":{"type":"string","description":"Account ID","nullable":true,"example":"acc_B518niGwGYKzig6vtrRVZGGGV"},"environment":{"type":"string","description":"Environment - Can be `test` or `production`","nullable":true,"example":"production"},"external_id":{"type":"string","description":"Payout ID in merchant's system","nullable":true,"example":"1268ce56-a4b5-43fa-8526-a500fc2140bb"},"status":{"type":"string","description":"Payout status","nullable":true,"example":"successful"},"declined_reason":{"type":"string","description":"Decline reason","nullable":true,"example":"Card lost/stolen"},"transaction_id":{"type":"string","description":"Transaction ID","nullable":true,"example":"trx_6QgmXzQzk3S5K5EsR3DfEiMRj"},"amount":{"type":"integer","description":"Amount of the payout in cents","format":"int64","example":9500},"currency":{"type":"string","description":"3 character ISO currency code","nullable":true,"example":"USD"},"payment_method":{"type":"object","properties":{"card":{"type":"object","properties":{"id":{"type":"string","description":"Payment Method ID","nullable":true,"example":"card_8PajTnDVrviEJ8zYJDALFQm5t"},"cardholder_name":{"type":"string","description":"Cardholder name","nullable":true,"example":"John Smith"},"last4":{"type":"string","description":"Last 4 digits of the card","nullable":true,"example":"4242"},"exp_month":{"type":"string","description":"Card expiration month","nullable":true,"example":"12"},"exp_year":{"type":"string","description":"Card expiration year","nullable":true,"example":"2025"},"fingerprint":{"type":"string","description":"Fingerprint of the card to identify uniqueness","nullable":true,"example":"CC2XvyoohnqecEq4r3FtXv6MdCx4TbaW1UUTdCCN5MNL"},"brand":{"type":"string","description":"Card brand","nullable":true,"example":"visa"},"avs_code":{"type":"string","description":"AVS code","nullable":true,"example":"Y"},"cvv2_reply":{"type":"string","description":"CVV2 reply","nullable":true,"example":"M"}},"additionalProperties":false,"title":"PaymentCard"},"bank_account":{"type":"object","properties":{"id":{"type":"string","description":"Payment Method ID","nullable":true,"example":"ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ"},"account_holder_name":{"type":"string","description":"Account Holder Name","nullable":true,"example":"John Doe"},"account_holder_type":{"type":"string","description":"AccountHolderType - Can be `individual` or `company`","nullable":true,"example":"individual"},"account_type":{"type":"string","description":"AccountType - Can be `checking` or `savings`","nullable":true,"example":"individual"},"routing_number":{"type":"string","description":"Routing Number","nullable":true,"example":"123456789"},"account_number_last4":{"type":"string","description":"Last 4 digits of the account number","nullable":true,"example":"1011"}},"additionalProperties":false,"title":"PaymentBankAccount"},"account_balance":{"type":"object","properties":{"account_id":{"type":"string","description":"Account ID","nullable":true,"example":"acc_B518niGwGYKzig6vtrRVZGGGV"},"account_name":{"type":"string","description":"Account Name","nullable":true,"example":"Test Company, LLC"}},"additionalProperties":false,"title":"PaymentAccountBalance"}},"additionalProperties":false,"title":"PaymentPaymentMethod"},"customer":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID","nullable":true,"example":"cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ"},"external_id":{"type":"string","description":"Customer ID in merchant's system","nullable":true,"example":"e797ef3c-b586-4333-af90-7168d8427d85"},"business_name":{"type":"string","description":"Name of the business if business customer type","nullable":true,"example":"Awesome Company, LLC"},"first_name":{"type":"string","description":"First name of the person if person customer type","nullable":true,"example":"John"},"last_name":{"type":"string","description":"Last name of the person if person customer type","nullable":true,"example":"Smith"},"email":{"type":"string","description":"Email address","nullable":true,"example":"john.smith@email.com"},"phone":{"type":"string","description":"Phone number","nullable":true,"example":"+15554829347"}},"additionalProperties":false,"title":"TransactionCustomer"},"billing_details":{"required":["address_line_1","city","country","postal_code","state"],"type":"object","properties":{"address_line_1":{"maxLength":250,"minLength":1,"type":"string","description":"Street name","example":"111 Colorado Ave."},"address_line_2":{"maxLength":250,"type":"string","description":"Apt, Suite or PO Box","nullable":true,"example":"Apt 403"},"city":{"maxLength":100,"minLength":1,"type":"string","description":"City","example":"Des Moines"},"state":{"maxLength":3,"minLength":2,"type":"string","description":"2 or 3 character ISO state code","example":"IA"},"postal_code":{"maxLength":30,"minLength":1,"type":"string","description":"Postal or zip code","example":"51111"},"country":{"maxLength":2,"minLength":1,"type":"string","description":"2 character ISO country code","example":"US"}},"additionalProperties":false,"title":"Address"},"created_at":{"type":"string","description":"Date payment was created","format":"date-time","nullable":true,"example":"2024-06-30T01:02:29.212Z"},"modified_at":{"type":"string","description":"Date payment was modified","format":"date-time","nullable":true,"example":"2024-06-30T01:02:29.212Z"}},"additionalProperties":false,"title":"Payout"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true},"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{},"title":"ValidationProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{},"title":"ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{},"title":"ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{},"title":"ProblemDetails"}}}}}}
+>
+
+</StatusCodes>
+
+
+