DistributionPayment

A distribution payment is the amount one entity receives from a distribution. Each payment moves through its own status, independently of the other payments in the distribution.

Status

Status	Meaning
`staged`	Waiting on the recipient. No money has moved
`recipient_confirmed`	The recipient confirmed where to send the money. Sets `recipient_confirmed_at`
`verified`	The sender verified the recipient’s payment details. Sets `verified_at`
`disbursed`	A transfer was submitted. It may still be queued at the bank partner, or the money may already have arrived
`failed`	A transfer was submitted, none is in flight or settled, and the most recent transfer to end failed, was rejected or was cancelled
`returned`	A transfer was submitted, none is in flight or settled, and the bank sent back the most recent transfer to end

Until a transfer is submitted, a rejected or cancelled one leaves the payment at its earlier status.

disbursed means a transfer was submitted, not that the money arrived. Follow the payment’s transactions for its bank status.

A payment can move back. Retrying a failed or returned payment moves it to disbursed. Returning it to staged clears recipient_confirmed_at and verified_at, and its earlier transfers no longer count toward its status.

Transactions

Every transaction caused by a payment carries it in workflow:

{
  "workflow": {
    "type": "distribution",
    "id": "dst_…",
    "payment": "dpmt_…",
    "entity": "ent_…"
  }
}

Match workflow.payment to the payment’s id to find its money movement, including fees and any return.

Payment instructions

payment_instructions is the payment instructions the money is sent to. It is null until instructions are chosen for the payment.

Conventions

Objects

Dates and times

DistributionPayment

Status

Transactions

Payment instructions

​Status

​Transactions

​Payment instructions

​Related

Status

Transactions

Payment instructions

Related