Schedule a Payment using Payable API

Overview

This guide will show you how to use the Payable API to schedule a payment for a future date. By scheduling payment ahead of time users gain more control over their payment process, ensuring they meet important payment dates without the need for immediate processing.

Even after scheduling you retain the flexibility to update or cancel the payable.

On the defined "payableEffectiveDate", the Payable API will automatically process the payment.

Step 1: Prepare the request

  • Endpoint: /Payables

  • Method: POST

  • Body: For the request body include all the necessary fields for a standard payment. Additionally specify the payableEffectiveDate, a dateTime value that indicates when the payment should be processed. Ensure this date is set for a future time.

Step 2: Send the POST request

Using your preferred method (command line, Postman, or a script), send the POST request to the endpoint. 

Step 3: Handle the response

After you schedule the payment, the API will send a "202 Accepted" status code. This response will give you the recordNumber for the scheduled payable.

The status for this payable will be "Scheduled". The payment will be made on the date specified in payableEffectiveDate.

If needed, you can change or cancel a scheduled payable.

Example

{
    "payableReferenceId": "573a6503-d07b-466c-8b97-fd2bf8150386",
    "recordNumber": "4fd839d4-6f34-4a41-be3d-366bc1c3798b",
    "netTotal": 500.00,
    "isoCurrencyCode": "USD",
    "payableTerms": "NET30",
    "payableDueDate": "2023-12-22",
    "payableEffectiveDate": "2023-12-22",
    "payableApprovalStatus": 2,
    "memo": "Payment covers damages sustained by vehicle (Toyota Camry, 2020, 1339MN) during the storm incident on August 18, 2023. It also covers rental fees for a vehicle during car's repair period).",
    "remittance": {
        "grossTotal": 500.00,
        "grossDiscount": 1.00,
        "tax": 0.00,
        "lineItems": [
        ]
    },
    "paymentInfo": {
        "originationAccountReferenceId": "1b6910ab-c944-446a-b372-076edb49c63e",
        "destinationFinancialInformation": {
            "isoCurrencyCode": "USD",
            "bankAccountDetails": {
                "nameOnAccount": "",
                "bankAccountNumber": "",
                "bankRoutingNumber": ""
            },
            "paypalDetails": {},
            "cardDetails": {},
            "methodOfPayment": 5,
            "foreignExchangeInfo": {
                "originationIsoCurrencyCode": "USD",
                "destinationIsoCurrencyCode": "USD"
            }
        },
        "smartDisburseDetails": {
            "templateId": 1,
            "applyPaymentFallbackToDeliveryMethod": true,
            "behaviors": [
                "ACH",
                "VirtualCard",
                "MCSend",
                "RTP",
                "Check"
            ]
        }
    },
    "payees": [
        {
            "partyReferenceId": "2978a5d5-81f0-4db4-abc7-d15b7e15e328",
            "firstName": "Bridget",
            "lastName": "Rose",
            "isBusiness": false,
            "socialSecurityNumber": "323434234",
            "dateOfBirth": "1990-01-01",
            "emailAddress": "bridget.rose@example.com",
            "phoneNumber": "7572119665",
            "smartDisburse": {
                "isEndorseOnly": false,
                "isPrimary": true,
                "amount": 500.00,
                "securityQuestions": [
                    {
                        "question": "What is your claim number?",
                        "answer": "1234"
                    }
                ],
                "tokenDeliveryMethods": {
                    "emailAddress": "bridget.rose@example.com",
                    "smsPhoneNumber": ""
                }
            },
            "address": {
            }
        }
    ]
}