Skip to main content

Outbound Payments

POST Get Outbound Payment Timeline

The POST Get Payment Timeline method returns a chronological timeline of key status changes for a specified outbound payment. This includes information such as when the payment was initiated, when a check was printed or accepted, or when the payment was canceled. Each entry in the timeline includes the payment status, the method-specific status, and the timestamp of the change. This method enables merchants to track the lifecycle of a payment and its current and historical state.

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

API Endpoint
https://api.uat.anddone.com/vendorapi/secure/outboundPayments/timelines
API Data Details
URI vendorapi/secure/outboundPayments/timelines
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

Request Parameters (v2.3)

Field Name Data Type Mandatory Field Length Description
paymentId String true NA The unique ID of the payment.

Body Request Example (JSON)

Response Parameters (v2.3)

Body Response Example (JSON): Cancelled Payment

{
    "paymentStatus": "InProcess",
    "paymentMethodStatus": "Accepted",
    "modifiedOn": "03-25-2025 18:34:12"
},
{
    "paymentStatus": "Cancelled,"
    "paymentMethodStatus": "Cancelled",
    "modifiedOn": "03-25-2025 19:34:12"
}

Body Response Example (JSON): Processed Payment

{
    "paymentStatus": "InProcess",
    "paymentMethodStatus": "Accepted",
    "modifiedOn": "03-25-2025 18:34:12"
},
{
    "paymentStatus": "InProcess,"
    "paymentMethodStatus": "Print queued",
    "modifiedOn": "03-25-2025 19:34:12"
},
{
    "paymentStatus": "InProcess,"
    "paymentMethodStatus": "printed",
    "modifiedOn": "03-25-2025 19:34:12"
},
{
    "paymentStatus": "InProcess,"
    "paymentMethodStatus": "Mailed",
    "modifiedOn": "03-25-2025 19:34:12"
},
{
    "paymentStatus": "InProcess,"
    "paymentMethodStatus": "Transit",
    "modifiedOn": "03-25-2025 19:34:12"
},
{
    "paymentStatus": "InProcess,"
    "paymentMethodStatus": "Delivered",
    "modifiedOn": "03-25-2025 19:34:12"
}