cdp_sdk::api::types

Struct Disbursement

pub struct Disbursement {Show 14 fields
    pub amount: String,
    pub asset: Asset,
    pub created_at: DateTime<Utc>,
    pub customer_display: Option<DisbursementCustomerDisplay>,
    pub disbursement_id: DisbursementId,
    pub error: Option<PaymentError>,
    pub external_reference_id: Option<DisbursementExternalReferenceId>,
    pub metadata: Option<Metadata>,
    pub onchain_transactions: Vec<OnchainTransaction>,
    pub reason: Option<String>,
    pub source: DisbursementSource,
    pub status: PaymentActionStatus,
    pub target: DisbursementTarget,
    pub updated_at: DateTime<Utc>,
}

Expand description

A payment from a CDP account you own to a Coinbase user account or an onchain address, independent of a payment session.

JSON schema

{
 "description": "A payment from a CDP account you own to a Coinbase user account or an onchain address, independent of a payment session.",
 "examples": [
   {
     "amount": "25.00",
     "asset": "usdc",
     "createdAt": "2026-04-17T17:00:00.000Z",
     "customerDisplay": {
       "merchantName": "Acme Store",
       "referenceCode": "REF-ABC123"
     },
     "disbursementId": "disbursement_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
     "externalReferenceId": "disbursement-2026-04-1234",
     "metadata": {
       "customer_id": "cust_12345",
       "order_id": "order_67890"
     },
     "reason": "Goodwill disbursement for delayed shipment.",
     "source": {
       "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
       "asset": "usdc"
     },
     "status": "pending",
     "target": {
       "coinbaseUserId": "coinbase_user_abc123"
     },
     "updatedAt": "2026-04-17T17:00:00.000Z"
   }
 ],
 "type": "object",
 "required": [
   "amount",
   "asset",
   "createdAt",
   "disbursementId",
   "source",
   "status",
   "target",
   "updatedAt"
 ],
 "properties": {
   "amount": {
     "description": "A decimal representation of the disbursed amount, denominated in `asset`.",
     "examples": [
       "25.00"
     ],
     "type": "string"
   },
   "asset": {
     "description": "The symbol of the asset for the disbursement amount.",
     "examples": [
       "usdc"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/Asset"
       }
     ]
   },
   "createdAt": {
     "description": "The UTC ISO 8601 timestamp at which the disbursement was created.",
     "examples": [
       "2026-04-17T17:00:00.000Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "customerDisplay": {
     "description": "Display information shown to the recipient for this disbursement. If `referenceCode` was omitted when creating the disbursement, a generated code is returned.",
     "allOf": [
       {
         "$ref": "#/components/schemas/OperationCustomerDisplay"
       },
       {
         "type": "object",
         "properties": {
           "merchantName": {
             "description": "The merchant name displayed to the recipient. Reflects the supplied `merchantName` or the default merchant name configured for your entity.",
             "examples": [
               "Acme Store"
             ],
             "type": "string",
             "maxLength": 128,
             "x-audience": "public"
           }
         },
         "x-audience": "public"
       }
     ]
   },
   "disbursementId": {
     "description": "The unique identifier of the disbursement.",
     "examples": [
       "disbursement_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/DisbursementId"
       }
     ]
   },
   "error": {
     "description": "Error details, present only when the disbursement failed.",
     "examples": [
       {
         "code": "insufficient_funds",
         "message": "The source account does not have sufficient funds.",
         "occurredAt": "2026-04-17T17:01:00.000Z"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/PaymentError"
       }
     ]
   },
   "externalReferenceId": {
     "description": "An identifier from your system for tracking this disbursement. Not shown to the recipient. Must not contain personally identifiable information (PII) or payment credentials.",
     "examples": [
       "disbursement-2026-04-1234"
     ],
     "type": "string",
     "maxLength": 256
   },
   "metadata": {
     "$ref": "#/components/schemas/Metadata"
   },
   "onchainTransactions": {
     "description": "The onchain transactions associated with this disbursement.",
     "examples": [
       [
         {
           "network": "base",
           "transactionHash": "0xabc123def456789012345678901234567890abcdef1234567890abcdef123456"
         }
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/OnchainTransaction"
     }
   },
   "reason": {
     "description": "Human-readable reason for the disbursement.",
     "examples": [
       "Goodwill disbursement for delayed shipment."
     ],
     "type": "string"
   },
   "source": {
     "description": "The source from which the disbursement is funded.",
     "examples": [
       {
         "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
         "asset": "usdc"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/DisbursementSource"
       }
     ]
   },
   "status": {
     "description": "The current status of the disbursement.",
     "examples": [
       "pending"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/PaymentActionStatus"
       }
     ]
   },
   "target": {
     "description": "The target receiving the disbursement.",
     "examples": [
       {
         "coinbaseUserId": "coinbase_user_abc123"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/DisbursementTarget"
       }
     ]
   },
   "updatedAt": {
     "description": "The UTC ISO 8601 timestamp at which the disbursement was last updated.",
     "examples": [
       "2026-04-17T17:00:00.000Z"
     ],
     "type": "string",
     "format": "date-time"
   }
 }
}

Fields§

§amount: String

A decimal representation of the disbursed amount, denominated in asset.

§asset: Asset

The symbol of the asset for the disbursement amount.

§created_at: DateTime<Utc>

The UTC ISO 8601 timestamp at which the disbursement was created.

§customer_display: Option<DisbursementCustomerDisplay>§disbursement_id: DisbursementId

The unique identifier of the disbursement.

§error: Option<PaymentError>

Error details, present only when the disbursement failed.

§external_reference_id: Option<DisbursementExternalReferenceId>

An identifier from your system for tracking this disbursement. Not shown to the recipient. Must not contain personally identifiable information (PII) or payment credentials.

§metadata: Option<Metadata>§onchain_transactions: Vec<OnchainTransaction>

The onchain transactions associated with this disbursement.

§reason: Option<String>

Human-readable reason for the disbursement.

§source: DisbursementSource

The source from which the disbursement is funded.

§status: PaymentActionStatus

The current status of the disbursement.

§target: DisbursementTarget

The target receiving the disbursement.

§updated_at: DateTime<Utc>

The UTC ISO 8601 timestamp at which the disbursement was last updated.