Skip to content

When a payment is processed, Ripple Payments Direct may return execution metadata from the payout network in an optional field called payoutExecutionDetails on the Get Payment by ID response. When present, this object provides tracking information that can be used for audit, reconciliation, or customer inquiry resolution.

payoutExecutionDetails is not returned on every payment. Its presence depends on whether the network that processed the payment supports execution detail reporting. Treat this field as optional enrichment and do not build required workflows that depend on its presence.

Fields

The payoutExecutionDetails object contains the following fields:

Field TypeDescription
paymentRailUsedstringThe payment rail or network used to execute the payout (for example, FEDWIRE, ACH, SEPA_CT).
payoutStartTimeISO 8601 timestampThe time at which payout execution began, in UTC.
payoutEndTimeISO 8601 timestampThe time at which payout execution completed or was last updated, in UTC. For in-progress payouts, this may represent the last status update time.
trackingReferencesarrayOne or more network-specific tracking identifiers. See Tracking references.

Tracking references

Each entry in the trackingReferences array represents a single network-specific identifier for the payment. The array may contain more than one entry.

Field TypeDescription
referenceTypestringIdentifies what the reference value represents (for example, IMAD, END_TO_END_REFERENCE, CRYPTO_TRANSACTION_HASH).
valuestringThe reference value.
displayNamestringA human-readable label for the reference type.
descriptionstringA brief explanation of the reference type.

Use the referenceType field to identify what each value represents. Do not rely on the position of entries in the array, as the order is not guaranteed.

Example

The following is an example payoutExecutionDetails object as it would appear in a Get Payment by ID response:

{
  "payoutExecutionDetails": {
    "paymentRailUsed": "FEDWIRE",
    "payoutStartTime": "2026-02-18T14:22:15.789Z",
    "payoutEndTime": "2026-02-18T14:25:30.123Z",
    "trackingReferences": [
      {
        "referenceType": "IMAD",
        "value": "20260218MMQFMP2P003836",
        "displayName": "Input Message Accountability Data",
        "description": "A unique identifier assigned by the Fedwire system to each transaction."
      }
    ]
  }
}

Guidance

  • payoutExecutionDetails should be treated as informational only. Do not build required workflows that depend on its presence, as availability varies and is not guaranteed for any specific payment.
  • When present, trackingReferences provides network-specific identifiers useful for audit, reconciliation, or customer inquiry resolution.
  • Use the referenceType field on each tracking reference to identify what a value represents rather than relying on its position in the array.
  • Coverage will expand as additional corridors and networks are onboarded.