Skip to main content

Outbound Payments

POST Search Outbound Payments

The Search Outbound Payments method allows you to query outbound payment records based on various filter criteria, such as vendor ID, vendor name, payment ID, payment amount, payment method, and payment date. This method returns a paginated list of matching payment records, including details like payment method, vendor information, request date, status, and amount.

Note: This API is supported in AndDone version 2.3 only.

API Endpoint
https://api.uat.anddone.com/vendorapi/secure/outboundpayments/search
API Data Details
URI vendorapi/secure/outboundpayments/search
Method POST
Authorization API Key Authorization
Authorization
x-api-key API key {env_merchantAccessKey}
Request Headers
x-app-key Merchant ID or App Key {env_merchantId}
x-version API version (e.g., 2.3)
Origin URL or IP address provided to AndDone as an allowed origin.
Content-Type application/json

Query Parameters

Parameter Description
paymentMethodType Filters results by the type of payment method used.
vendorID Filters results by the unique vendor ID.
vendorName Filters results by the vendor's name.
paymentId Filters results by the unique ID of the outbound payment.
requestedDate Filters results by the date the payment was requested. Format: MM-DD-YYYY.
paymentStatus Filters results by the status of the payment (e.g., Pending, Printed, Canceled).
amount Filters results by the payment amount.

Request

Example Request
https://api.uat.anddone.com/vendorapi/secure/outboundpayments/search?vendorId=2v6LbQ28

Response

Body Response Example (JSON)

{
    "totalAmount": 10402.039999999999,
    "totalRowCount": 6,
    "data": [
        {
            "id": "6RdQrbvX",
            "merchantId": "Vn8M1N82",
            "merchantDBAName": "SriTestQATliveIP",
            "paymentMethodType": "Checks",
            "paymentBasedId": "C2v6LbQ28",
            "vendorId": "2v6LbQ28",
            "vendorName": "Mia test",
            "paymentId": "472f50c9-4492-4a1f-a97f-be14156fd077",
            "paymentMethodStatus": "Accepted",
            "requestedDate": "03/24/2025 22:27:03",
            "amount": "1750.34"
        },
        {
            "id": "gNxr4Ddl",
            "merchantId": "Vn8M1N82",
            "merchantDBAName": "SriTestQATliveIP",
            "paymentMethodType": "Checks",
            "paymentBasedId": "C2v6LbQ28",
            "vendorId": "2v6LbQ28",
            "vendorName": "Mia test",
            "paymentId": "fe754e75-0798-4c9f-878b-34c26c9b2916",
            "paymentMethodStatus": "Print queued",
            "requestedDate": "03/24/2025 23:12:15",
            "amount": "1500.34"
        },
        {
            "id": "1Dv40VvR",
            "merchantId": "Vn8M1N82",
            "merchantDBAName": "SriTestQATliveIP",
            "paymentMethodType": "Checks",
            "paymentBasedId": "C2v6LbQ28",
            "vendorId": "2v6LbQ28",
            "vendorName": "Mia test",
            "paymentId": "51d6861d-e27d-410f-9b9a-b7ec836584e1",
            "paymentMethodStatus": "printed",
            "requestedDate": "03/24/2025 23:16:47",
            "amount": "1800.34"
        },
        {
            "id": "GDxLR6dV",
            "merchantId": "Vn8M1N82",
            "merchantDBAName": "SriTestQATliveIP",
            "paymentMethodType": "Checks",
            "paymentBasedId": "C2v6LbQ28",
            "vendorId": "2v6LbQ28",
            "vendorName": "Mia test",
            "paymentId": "71842598-c903-45dd-8496-41fd7a5c4a68",
            "paymentMethodStatus": "Mailed",
            "requestedDate": "03/24/2025 23:17:28",
            "amount": "1800.34"
        },
        {
            "id": "NJ8Pr2vm",
            "merchantId": "Vn8M1N82",
            "merchantDBAName": "SriTestQATliveIP",
            "paymentMethodType": "Checks",
            "paymentBasedId": "C2v6LbQ28",
            "vendorId": "2v6LbQ28",
            "vendorName": "Mia test",
            "paymentId": "59a0e4b7-9978-4af8-8913-d8bf2712616d",
            "paymentMethodStatus": "Transit",
            "requestedDate": "03/24/2025 23:19:05",
            "amount": "1800.34"
        },
        {
            "id": "qKd2L1x6",
            "merchantId": "Vn8M1N82",
            "merchantDBAName": "SriTestQATliveIP",
            "paymentMethodType": "Checks",
            "paymentBasedId": "C2v6LbQ28",
            "vendorId": "2v6LbQ28",
            "vendorName": "Mia test",
            "paymentId": "48b11b20-b5d7-4751-9c5d-51ddb902ee35",
            "paymentMethodStatus": "Delivered",
            "requestedDate": "03/25/2025 23:34:12",
            "amount": "1750.34"
        }
    ]
}