Developer API

Transfer API

The Dots v2 API returns transfer and payout records with metadata about each transaction. This reference documents the response fields, including the ACH trace identifier used for payment tracking and support escalation.

Transfer Record Fields

When you retrieve a transfer or payout via the v2 API, the response includes the following key fields:

Field

Type

Description

id

string

Unique transfer identifier

status

string

Transfer status: created, pending, completed, or failed

amount

number

Transfer amount in cents

ach_trace_id

string

ACH trace identifier for ACH/RTP transfers. Use this value when contacting support about ACH payment issues.

created

string

ISO 8601 timestamp of when the transfer was created

ACH Trace ID

The ach_trace_id field is the primary identifier for ACH and RTP transfers. Banks use this trace ID to track the payment through the ACH network. Include this value when escalating ACH-related issues to Dots support.

The ach_trace_id only appears on ACH and RTP transfers. Other payment rails (PayPal, Venmo, international bank, etc.) do not include this field.

Example Response

{
  "id": "txn_abc123",
  "status": "completed",
  "amount": 10000,
  "ach_trace_id": "123456789012345",
  "created": "2024-01-15T10:30:00Z"
}

Compatibility Alias

Dashboard-only responses may include payout_trace_id as a compatibility alias for ach_trace_id. This is a temporary field that mirrors the ach_trace_id value.

API integrations should read ach_trace_id as the canonical field. The payout_trace_id alias exists only in dashboard outputs and will be removed in a future update.

If your integration currently uses payout_trace_id, update your code to use ach_trace_id instead. Both fields contain the same value during the transition period.

When to Use the ACH Trace ID

  • Support escalation: Provide the ach_trace_id when contacting Dots support about an ACH transfer that is delayed or untraceable at the receiving bank.

  • Bank inquiries: The trace ID helps receiving banks locate ACH payments in their systems.

  • Reconciliation: Use ach_trace_id to match Dots transfers against bank statements and accounting records.

Legacy Data

Transfers created before this field was added may have ach_trace_id populated from previously stored values during migration. If ach_trace_id is null or not present for an older transfer, contact support with the transfer id instead.

For transfer status definitions and troubleshooting, see Where is my money? For dashboard instructions on locating transfers, see Getting Started with the Dots Dashboard.

Was this helpful?
Was this helpful?