Payments

Update payment

Update a payment with accounts.

patch/v1/payments/{paymentId}

Request

Path parameters

paymentIdstring required

Unique identifier of the payment to update

Request body

organization_reference_idstring

Optional external reference ID for tracking.

funding_account_idstring required

ID of the account that ultimately funds the payment, used to identify the originator for Travel Rule purposes. Must belong to a counterparty or tenant; a workspace-owned account is rejected with payments-3099.

Response

Payment updated successfully

Example response

{
  "data": {
    "id": "5a9c3e7f-2b1d-4f48-a6e0-8c4b2d1f9a3e",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": "ref_123",
    "direction": "inbound",
    "funding_account_id": "2a8f4c1e-9b3d-4e56-b7a0-5c6d2e1f9b3a",
    "risk_status": "automatically_approved",
    "risk_status_reasons": [
      {
        "risk_status_reason_type": "OWNERSHIP",
        "risk_status_reason_category": "Exchange",
        "risk_status_reason_participant_id": null,
        "risk_status_reason_message": "Address has OWNERSHIP activity for Exchange over its threshold",
        "risk_status_reason_severity": "Low",
        "risk_status_reason_significance": "DECISIVE",
        "volume_usd_percent": "60.00",
        "volume_usd_percent_threshold": "1",
        "volume_usd_amount": "30000.00",
        "volume_usd_amount_threshold": null,
        "confidence_score": null,
        "confidence_score_threshold": null
      },
      {
        "risk_status_reason_type": "COUNTERPARTY",
        "risk_status_reason_category": "Gaming",
        "risk_status_reason_participant_id": null,
        "risk_status_reason_message": "Address has COUNTERPARTY exposure to Gaming over its threshold",
        "risk_status_reason_severity": "Low",
        "risk_status_reason_significance": "DECISIVE",
        "volume_usd_percent": "12.00",
        "volume_usd_percent_threshold": "2",
        "volume_usd_amount": "6000.00",
        "volume_usd_amount_threshold": null,
        "confidence_score": null,
        "confidence_score_threshold": null
      }
    ],
    "provider_metadata": [],
    "participants": [
      {
        "role": "BENEFICIARY",
        "resource": {
          "resource_type": "WORKSPACE",
          "id": "b53f6690-3242-4942-9907-885779632832",
          "name_match_score": null,
          "name_match_threshold": null,
          "name_match_comparison_id": null,
          "resolution": "USER_SUPPLIED_ID"
        }
      },
      {
        "role": "ORIGINATOR_VASP",
        "resource": {
          "resource_type": "COUNTERPARTY",
          "id": "a4c1f0b8-2e9d-4a63-b7c5-1d8f6e0a3c92",
          "name_match_score": "100",
          "name_match_threshold": "85",
          "name_match_comparison_id": "a4c1f0b8-2e9d-4a63-b7c5-1d8f6e0a3c92",
          "resolution": "EXACT_MATCH"
        }
      }
    ],
    "balance_status": "unreserved",
    "steps": [],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-02T10:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.