*** title: Cookbooks and recipes home subtitle: Use these quick tutorials to integrate Payabli workflows fast description: >- Browse quickstart recipes and cookbooks organized by product area to integrate Payabli for accepting payments, making payouts, and managing your operations 'og:description': >- Browse quickstart recipes and cookbooks organized by product area to integrate Payabli for accepting payments, making payouts, and managing your operations keywords: >- embedded payments, cookbooks, recipes, payment tutorials, API quickstart, Pay In, Pay Out, Pay Ops, integration guides slug: cookbooks/cookbooks-overview icon: hat-chef layout: guide area: * Pay In * Pay Out * Pay Ops audience: * developers * partners * merchants *** This page contains recipes that are designed to help you use and integrate Payabli. Recipes are short tutorials that cover a workflow. We've organized these by Payabli product area. This page is under construction, we're working hard to bring you more recipes and cookbooks. Stay tuned! ## General recipes
/// Step 1: Get your API token Navigate to **PartnerHub > Developers > API Tokens** and create a new organization token. Your API tokens carry privileges, so keep them secure! Your token will look something like this: `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` /// Step 2: Add token to request headers Send the API token in the request header with the key `requestToken`. All API requests must be made over HTTPS. ```bash highlight=3 curl -X POST "https://api.payabli.com/api/ExampleEndpoint/authorize" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" ``` /// Step 3: Add idempotency key (recommended) Include a unique `idempotencyKey` header to prevent duplicate transactions. This key persists for 2 minutes. ```bash highlight=4 curl -X POST "https://api.payabli.com/api/ExampleEndpoint/authorize" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -H "idempotencyKey: unique-request-id-123" ``` Learn more about authentication, API tokens, and idempotency in [API overview](/developers/api-reference/api-overview).
## Pay In recipes Use these recipes to get you started with Pay In features and functions. See [Pay In overview](/guides/pay-in-overview) for more.
/// Overview This end-to-end workflow walks through how to run a card sale transaction using the API. The `getpaid` endpoint authorizes and captures the transaction in one step, so it's immediately captured for settlement. This recipe uses the [v2 transaction API](/developers/api-reference/moneyIn/v2), which all new integrations should use. /// Prerequisites Before you start, make sure you have the following: * Your paypoint's `entryPoint` value * A `customerId` for the customer making the payment. If you don't have one, [create a customer](/cookbooks/cookbooks-overview?recipe=Create%20a%20customer) first. * The customer's payment details: for a card transaction, this includes the card number, expiration date, CVV, and billing ZIP code **PCI compliance note:** This recipe passes raw card data directly through the API for demonstration purposes. In production, use an [embedded component](/guides/embedded-components-overview) to collect card details, or use a stored payment method, which keeps your PCI scope minimal. If you handle raw card data directly, your PCI scope is expanded and you must secure cardholder data and customer IP addresses. /// Step 1: Run the sale transaction Send a POST request to `/api/v2/MoneyIn/getpaid` with the payment method, amount, and customer information. This authorizes and captures the transaction in one step. ```bash curl -X POST "https://api.payabli.com/api/v2/MoneyIn/getpaid" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "entryPoint": "your-entry-point", "paymentMethod": { "method": "card", "cardHolder": "Jane Smith", "cardnumber": "4111111111111111", "cardexp": "02/27", "cardcvv": "999", "cardzip": "12345", "initiator": "payor" }, "paymentDetails": { "totalAmount": 100.00, "serviceFee": 0 }, "customerData": { "customerId": 4440 }, "ipaddress": "255.255.255.255" }' ``` A successful response returns code `A0000` (Approved) and a `paymentTransId` in the `data` object that you can use to look up the transaction later. ```json highlight=2,7 { "code": "A0000", "reason": "Approved", "explanation": "Transaction approved", "action": "No action required", "data": { "paymentTransId": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae", "method": "card", "transStatus": 1, "totalAmount": 100, "netAmount": 100, "payorId": 4440 }, "token": null } ``` See [Make a transaction (v2)](/developers/api-reference/moneyinV2/make-a-transaction) for the full API reference. /// Step 2: Check the transaction status Use the `paymentTransId` from the previous step to check the transaction's status and details. Send a GET request to `/api/MoneyIn/details/{paymentTransId}`. ```bash curl -X GET "https://api.payabli.com/api/MoneyIn/details/3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae" \ -H "requestToken: YOUR_API_TOKEN" ``` Since the `getpaid` endpoint authorizes and captures in one step, the `transStatus` is Captured (1). To track settlement progress, watch the `settlementStatus` field as it moves from Pending (0) through In Transit (1), Transferred (2), and Funded (3). See the [Pay In lifecycle](/guides/pay-in-transactions-lifecycle-overview) for more. See [Get details for a processed transaction](/developers/api-reference/moneyin/get-details-for-a-processed-transaction) for the full API reference. /// What's next Congratulations! You just ran your first sale transaction. Next, learn about the [Pay In transaction lifecycle](/guides/pay-in-transactions-lifecycle-overview) and explore [running transactions with other payment methods](/guides/pay-in-developer-transactions-create). /// Overview Create a customer record in Payabli to track payers, store payment methods, and manage subscriptions. Customer records require at least one identifier field. /// Prerequisites Before you start, make sure you have the following: * Your paypoint's `entrypoint` value * At least one customer identifier: `firstname` and `lastname`, `email`, or a custom identifier Check your identifier settings in **Settings > Custom Fields** in PartnerHub. See [custom identifiers](/guides/pay-ops-developer-customers-manage#custom-identifiers) for more. /// Create the customer Send a POST request to `/api/Customer/single/{entry}` with the customer's details. Include identifier fields so Payabli can match against existing records. ```bash curl -X POST "https://api.payabli.com/api/Customer/single/your-entry-point" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "customerNumber": "12356ACB", "firstname": "Irene", "lastname": "Canizales", "address1": "123 Bishops Trail", "city": "Mountain City", "state": "TN", "zip": "37612", "country": "US", "email": "irene@canizalesconcrete.com", "identifierFields": ["email"], "timeZone": -5 }' ``` The response includes a `customerId` that you can use with other endpoints to manage the customer and run transactions. ```json highlight=4 { "isSuccess": true, "responseData": { "customerId": 17264, "customerNumber": "12356ACB", "customerStatus": 0, "Firstname": "Irene", "Lastname": "Canizales", "Email": "irene@canizalesconcrete.com" }, "responseText": "Success" } ``` See [Add customer](/developers/api-reference/customer/add-customer) for the full API reference. /// What's next Congratulations! You've created a customer record. Learn more about [managing customers with the API](/guides/pay-ops-developer-customers-manage) and [customer entities in Payabli](/guides/platform-entities-overview). /// Overview Refund a settled Pay In transaction to return funds to the customer. You can refund the full amount or a partial amount. This recipe uses the [v2 API](/guides/pay-in-developer-transactions-cancel#v1-and-v2-endpoints). /// Prerequisites Before you start, make sure you have the following: * The `referenceId` of a settled transaction (also called the `transId`) * The refund amount, if you're issuing a partial refund If the transaction hasn't settled yet, [void it](/developers/api-reference/moneyinV2/void-a-transaction) instead. /// Refund the transaction For a full refund, send a POST request to `/api/v2/MoneyIn/refund/{transId}`. For a partial refund, append the amount: `/api/v2/MoneyIn/refund/{transId}/{amount}`. The refund amount excludes any service fee charged on the original transaction. This example refunds the full transaction amount: ```bash curl -X POST "https://api.payabli.com/api/v2/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" ``` A successful refund returns a `code` of `A0004` with a `reason` of "Refunded". The `data` object contains the full transaction details. ```json { "code": "A0004", "reason": "Refunded", "explanation": "Transaction refunded", "action": "No action required", "data": { "paymentTransId": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae", "method": "card", "paymentData": { "maskedAccount": "4XXXXXXXXXXX5439", "accountType": "visa", "holderName": "John Cassian" } }, "token": null } ``` To refund a partial amount, include the amount in the path. This example refunds \$100.99: ```bash curl -X POST "https://api.payabli.com/api/v2/MoneyIn/refund/10-3ffa27df-b171-44e0-b251-e95fbfc7a723/100.99" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" ``` See [Refund a settled transaction (v2)](/developers/api-reference/moneyinV2/refund-a-settled-transaction) for the full API reference. /// What's next Congratulations! You've refunded a Pay In transaction. Learn about [choosing between void and refund](/guides/pay-in-transactions-void-vs-refund-decision) and the [Enhanced Refund Flow](/guides/pay-in-refunds-enhanced-flow-overview). /// Overview Void an unsettled Pay In transaction to cancel it before the batch closes. Voids cancel the full transaction amount — partial voids aren't supported. This recipe uses the [v2 API](/guides/pay-in-developer-transactions-cancel#v1-and-v2-endpoints). /// Prerequisites Before you start, make sure you have the following: * The `referenceId` of an unsettled transaction (also called the `transId`) If the transaction has already settled, [refund it](/developers/api-reference/moneyinV2/refund-a-settled-transaction) instead. /// Void the transaction Send a POST request to `/api/v2/MoneyIn/void/{transId}`. ```bash curl -X POST "https://api.payabli.com/api/v2/MoneyIn/void/10-3ffa27df-b171-44e0-b251-e95fbfc7a723" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" ``` A successful void returns a `code` of `A0003` with a `reason` of "Canceled". The `data` object contains the full transaction details. ```json { "code": "A0003", "reason": "Canceled", "explanation": "Transaction canceled", "action": "No action required", "data": { "paymentTransId": "3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae", "method": "card", "paymentData": { "maskedAccount": "4XXXXXXXXXXX5439", "accountType": "visa", "holderName": "John Cassian" } }, "token": null } ``` If you try to void a transaction that has already been settled or voided, the API returns a 400 status. See [Void a transaction (v2)](/developers/api-reference/moneyinV2/void-a-transaction) for the full API reference. /// What's next Congratulations! You've voided a Pay In transaction. Learn about [choosing between void and refund](/guides/pay-in-transactions-void-vs-refund-decision) and explore [other cancellation methods](/guides/pay-in-developer-transactions-cancel).
## Pay Out recipes Use these recipes help get you started with Pay Out features and functions. See [Pay Out overview](/guides/pay-out-overview) for more.
/// Overview This complete end-to-end workflow walks through how to send a payment to a vendor using ACH. /// Step 1: Create a vendor First, make sure that you have a vendor record. If you already have a `vendorNumber`, you can skip to step 2. To create a vendor, send a POST request to `/api/Vendor/single/{entry}`. ```bash curl -X POST "https://api.payabli.com/api/Vendor/single/your-entry-point" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "vendorNumber": "V-001", "name1": "My First Vendor", "email": "vendor@example.com", "paymentMethod": "ach", "vendorStatus": 1 }' ``` You need the `vendorNumber` you set for the vendor in the next step. See [Create vendor](/developers/api-reference/vendor/create-vendor) for the full API reference. /// Step 2: Create a bill for the vendor Send a POST request to `/api/Bill/single/{entry}` to add a bill that represents the invoice you need to pay. This is optional but **strongly** recommended for tracking. ```bash focus=5 curl -X POST "https://api.payabli.com/api/Bill/single/your-entry-point" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "billNumber": "Test-234782", "netAmount": 2500.00, "billDate": "2025-01-08", "dueDate": "2025-02-08", "comments": "Q1 supplies order", "vendor": { "vendorNumber": "V-001" } }' ``` The `billId` is returned in `responseData`. Copy this to use in the next step. ```json highlight=7 { "responseText": "Success", "responseCode": 1, "pageIdentifier": null, "roomId": 0, "isSuccess": true, "responseData": 6101 } ``` See [Create bill](/developers/api-reference/bill/add-bill) for the full API reference. /// Step 3: Authorize the payout transaction Authorizing a payout creates the transaction, which is captured for processing later. To authorize a payout, send a POST request to `/api/MoneyOut/authorize`. ```bash curl -X POST "https://api.payabli.com/api/MoneyOut/authorize" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "entryPoint": "your-entry-point", "paymentMethod": { "method": "ach", // For managed payouts, used 'managed' here, and omit ACH fields "achHolder": "My First Vendor", "achRouting": "021000021", "achAccount": "123456789", "achAccountType": "Checking" }, "paymentDetails": { "totalAmount": 2500.00, "orderDescription": "First payout test" }, "vendorData": { "vendorNumber": "V-001" }, "invoiceData": [ { "billId": 6101 } ] }' ``` The response includes a `referenceId` (for example, `"129-001"`) that you need to capture the payout for processing in the next step. ```json highlight=9 { "responseCode": 1, "pageIdentifier": null, "roomId": 0, "isSuccess": true, "responseText": "Success", "responseData": { "authCode": null, "referenceId": "129-001", "resultCode": 1, "resultText": "Authorized", "avsResponseText": null, "cvvResponseText": null, "customerId": 0, "methodReferenceId": null } } ``` See [Authorize a transaction for payout](/developers/api-reference/moneyout/authorize-a-transaction-for-payout) for the full API reference. /// Step 4: Capture the payout for settlement Capturing an authorized payout adds it to a batch for processing. To capture the payout, send a GET request to `/api/MoneyOut/capture/{referenceId}`. ```bash curl -X GET "https://api.payabli.com/api/MoneyOut/capture/129-001" \ -H "requestToken: YOUR_API_TOKEN" ``` The payout is now captured and will process with the next batch at 5 PM ET. See [Capture an authorized payout transaction](/developers/api-reference/moneyout/capture-an-authorized-payout-transaction) for the full API reference. /// Step 5: Monitor transaction status Check the transaction status as it progresses through the payment lifecycle. To get the transaction details, send a GET request to `/api/MoneyOut/details/{referenceId}`. ```bash curl -X GET "https://api.payabli.com/api/MoneyOut/details/129-001" \ -H "requestToken: YOUR_API_TOKEN" ``` Watch for the status to progress: 1 (Captured) → 2 (Processing) → 3 (Processed) → 5 (Paid). * Learn more about [Pay Out statuses](/guides/pay-out-status-reference). * See [Get details for a processed payout transaction](/developers/api-reference/moneyout/get-details-for-a-processed-payout-transaction) for the full API reference. /// What's next Congratulations! You just processed your first payout. Next, get to know [payables](/guides/pay-out-payables-overview) and learn more about [managing payouts](/guides/pay-out-developer-payouts-manage). /// Overview Add a new vendor record with bank account details for ACH payments. /// Prerequisites Before you start, gather the following information. Payabli supports US and Canadian vendors only. * Vendor business information: name, email, phone, and address * A `vendorNumber` to identify the vendor in your system * Bank account details for ACH payments: routing number, account number, account type, and account holder name Including bank account details in `billingData` is not supported if you use [managed payouts](/guides/pay-out-managed-payables-overview). /// Step 1: Create the vendor Send a POST request to `/api/Vendor/single/{entry}` to create the vendor. The `entry` parameter is your entrypoint identifier. ```bash curl -X POST "https://api.payabli.com/api/Vendor/single/your-entry-point" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "vendorNumber": "V-001", "name1": "Acme Supplies Inc", "email": "ap@acme.com", "phone": "5125551234", "address1": "123 Main Street", "city": "Austin", "state": "TX", "zip": "78701", "country": "US", "paymentMethod": "ach", "vendorStatus": 1, "billingData": { "routingAccount": "021000021", "accountNumber": "123456789", "typeAccount": "Checking", "bankAccountHolderName": "Acme Supplies Inc", "bankAccountHolderType": "Business", "bankName": "Chase Bank" } }' ``` The response returns the Payabli-generated `vendorId` in `responseData`. ```json highlight=5 { "responseText": "Success", "isSuccess": true, "responseCode": 1, "responseData": 3890 } ``` See [Create vendor](/developers/api-reference/vendor/create-vendor) for the full API reference. /// Overview Send a payment to a vendor via ACH bank transfer with full transaction lifecycle. This recipe is for on-demand payouts and is not supported with [managed payouts](/guides/pay-out-managed-payables-overview). /// Prerequisites Before you start, make sure you have the following: * A `vendorNumber` for the vendor you're paying * The vendor's ACH information: account holder name, routing number, account number, and account type (checking or savings) * A `billId` if you're paying against a bill (recommended) /// Step 1: Authorize the payout Authorize the payout. This queues the transaction but doesn't process it until captured. To authorize a payout, send a POST request to `/api/MoneyOut/authorize`. ```bash curl -X POST "https://api.payabli.com/api/MoneyOut/authorize" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "entryPoint": "your-entry-point", "paymentMethod": { "method": "ach", "achHolder": "Acme Supplies", "achRouting": "021000021", "achAccount": "123456789", "achAccountType": "Checking" }, "paymentDetails": { "totalAmount": 1500.00, "orderDescription": "Invoice payment" }, "vendorData": { "vendorNumber": "V-001" }, "invoiceData": [ { "billId": 6101 } ] }' ``` The response includes a `referenceId` that you need to capture or cancel the transaction. ```json highlight=5 { "isSuccess": true, "responseData": { "authCode": null, "referenceId": "129-219", "resultCode": 1, "resultText": "Authorized" } } ``` See [Authorize a transaction for payout](/developers/api-reference/moneyout/authorize-a-transaction-for-payout) for the full API reference. /// Step 2: Capture the payout Capture the authorized transaction to add it to a batch for processing. Batches close at 5 PM ET. To capture the payout, send a GET request to `/api/MoneyOut/capture/{referenceId}`. ```bash focus=1 curl -X GET "https://api.payabli.com/api/MoneyOut/capture/129-219" \ -H "requestToken: YOUR_API_TOKEN" ``` See [Capture an authorized payout transaction](/developers/api-reference/moneyout/capture-an-authorized-payout-transaction) for the full API reference. /// Step 3: Monitor transaction status Check the transaction details to monitor the payout through its lifecycle: Captured → Processing → Processed → Paid. To get the transaction details, send a GET request to `/api/MoneyOut/details/{referenceId}`. ```bash curl -X GET "https://api.payabli.com/api/MoneyOut/details/129-219" \ -H "requestToken: YOUR_API_TOKEN" ``` See [Get details for a processed payout transaction](/developers/api-reference/moneyout/get-details-for-a-processed-payout-transaction) for the full API reference. /// Step 4: (Optional) Cancel if needed You can cancel authorized or captured transactions before the batch closes at 5 PM ET. To cancel a payout, send a DELETE request to `/api/MoneyOut/cancel/{referenceId}`. ```bash focus=1 curl -X DELETE "https://api.payabli.com/api/MoneyOut/cancel/129-219" \ -H "requestToken: YOUR_API_TOKEN" ``` See [Cancel a payout transaction](/developers/api-reference/moneyout/cancel-a-payout-transaction) for the full API reference. /// Overview This recipe walks through issuing a single-use virtual card to a vendor and sending the card link via email. This recipe is for on-demand payouts and is not supported with [managed payouts](/guides/pay-out-managed-payables-overview). /// Prerequisites Before you start, make sure you have the following: * A `vendorNumber` for the vendor you're paying * The vendor's email address to send the card link to /// Step 1: Create the virtual card payout Authorize a payout with `method: "vcard"`. This creates a single-use virtual card for the vendor. To authorize the payout, send a POST request to `/api/MoneyOut/authorize`. ```bash focus=7 curl -X POST "https://api.payabli.com/api/MoneyOut/authorize" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "entryPoint": "your-entry-point", "paymentMethod": { "method": "vcard" }, "paymentDetails": { "totalAmount": 500.00 }, "vendorData": { "vendorNumber": "V-001", "email": "vendor@example.com" } }' ``` The response includes a `referenceId` that you need to capture the payout transaction. ```json highlight=5 { "isSuccess": true, "responseData": { "authCode": null, "referenceId": "129-220", "resultCode": 1, "resultText": "Authorized" } } ``` See [Authorize a transaction for payout](/developers/api-reference/moneyout/authorize-a-transaction-for-payout) for the full API reference. /// Step 2: Capture the transaction Capture the authorized vCard payout to issue the card. To capture the payout, send a GET request to `/api/MoneyOut/capture/{referenceId}`. ```bash curl -X GET "https://api.payabli.com/api/MoneyOut/capture/129-220" \ -H "requestToken: YOUR_API_TOKEN" ``` See [Capture an authorized payout transaction](/developers/api-reference/moneyout/capture-an-authorized-payout-transaction) for the full API reference. /// Step 3: Send the card link Send the vendor an email with a secure link to view their virtual card details. To send the card link, send a POST request to `/api/vcard/send-card-link`. ```bash curl -X POST "https://api.payabli.com/api/vcard/send-card-link" \ -H "Content-Type: application/json" \ -H "requestToken: YOUR_API_TOKEN" \ -d '{ "transId": "129-220" }' ``` See [Send vCard link](/developers/api-reference/moneyout/send-vcard-link) for the full API reference. /// Step 4: Monitor for payment When the vendor uses the vCard, the transaction status changes to Paid. vCards remain open for 180 days if not used. Learn more about [Pay Out statuses](/guides/pay-out-status-reference).
## Pay Ops recipes Coming soon!