# Update carrier payment method

Partially update a carrier payment method. Only provided fields will be updated.

IMPORTANT: The carrierId field cannot be changed after creation.

Payment Recipient Type Constraints:
- When changing to DIRECT: carrierFactorId must be set to null
- When changing to FACTOR: carrierFactorId is required

- Omitted fields: Not modified (current value preserved)
- Provided fields: Updated to the new value
- Null values: Clear the field (set to null) where applicable

Endpoint: PATCH /carrier-payment-methods/{id}
Version: 1.0.0
Security: BearerAuth

## Path parameters:

  - `id` (string, required)
    Resource ID (UUID) or client key
    Example: "550e8400-e29b-41d4-a716-446655440000"

## Request fields (application/json):

  - `paymentRecipientType` (string)
    Who receives the payment.

- DIRECT: carrierFactorId must be null
- FACTOR: carrierFactorId is required
    Enum: "DIRECT", "FACTOR"

  - `paymentMethodType` (string)
    How payment is made
    Enum: "ACH_WIRE", "ZELLE", "VENMO", "ACH", "CHECK", "WIRE", "CAD_EFT", "TRIUMPH_PAY", "COMCHECK", "EFS", "ECHECK"

  - `status` (string,null)
    Payment method status
    Example: "ACTIVE"

  - `isPreferred` (boolean,null)
    Whether this is the preferred payment method
    Example: true

  - `email` (string,null)
    Email address for payment notifications
    Example: "payments@carrier.com"

  - `phone` (string,null)
    Phone number for payment contact
    Example: "+1-555-123-4567"

  - `companyName` (string,null)
    Company name for this payment method
    Example: "Carrier Payments LLC"

  - `username` (string,null)
    Username for payment platforms
    Example: "carrier_payments"

  - `bankName` (string,null)
    Bank name
    Example: "Chase Bank"

  - `bankAddress` (string,null)
    Bank address
    Example: "123 Bank Street, Dallas, TX 75201"

  - `accountName` (string,null)
    Bank account holder name
    Example: "Carrier Transport Inc"

  - `accountNumber` (string,null)
    Bank account number
    Example: "1234567890"

  - `abaAch` (string,null)
    ABA/ACH routing number
    Example: "021000021"

  - `wire` (string,null)
    Wire transfer routing number
    Example: "026009593"

  - `swiftCode` (string,null)
    SWIFT/BIC code
    Example: "CHASUS33"

  - `eftInstitution` (string,null)
    EFT institution number
    Example: "001"

  - `eftTransit` (string,null)
    EFT transit number
    Example: "00010"

  - `clabe` (string,null)
    CLABE number
    Example: "012180001234567897"

  - `currency` (string,null)
    Preferred currency code
    Example: "USD"

  - `carrierFactorId` (string,null)
    Carrier factor ID.

Constraint: Required when paymentRecipientType is FACTOR, must be null when DIRECT.
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `paymentTermId` (string,null)
    Payment term ID
    Example: "550e8400-e29b-41d4-a716-446655440002"

## Response 200 fields (application/json):

  - `id` (string, required)
    Unique carrier payment method identifier
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `carrierId` (string, required)
    Carrier profile ID (read-only after creation).

This field cannot be changed after the payment method is created.
    Example: "770e8400-e29b-41d4-a716-446655440000"

  - `carrier` (object, required)
    Carrier profile reference with full details

  - `carrier.id` (string, required)
    Carrier UUID
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `carrier.key` (string,null)
    Client-defined reference ID if set
    Example: "ERP-CARRIER-SWIFT"

  - `carrier.name` (string, required)
    Carrier company name
    Example: "Swift Transportation"

  - `carrier.phoneNumber` (string,null)
    Primary phone number
    Example: "+1-555-987-6543"

  - `carrier.email` (string,null)
    Primary email address
    Example: "dispatch@swifttrans.com"

  - `carrier.createdAt` (string, required)
    When the carrier was created
    Example: "2025-01-15T10:00:00Z"

  - `carrier.updatedAt` (string, required)
    When the carrier was last updated
    Example: "2025-01-15T14:30:00Z"

  - `carrier.deletedAt` (string,null)
    When the carrier was soft deleted (null if active)

  - `paymentRecipientType` (string, required)
    Who receives the payment.

- DIRECT: Payment goes directly to the carrier (carrierFactorId must be null)
- FACTOR: Payment goes to a factoring company (carrierFactorId is required)
    Enum: "DIRECT", "FACTOR"

  - `paymentMethodType` (string, required)
    How payment is made
    Enum: "ACH_WIRE", "ZELLE", "VENMO", "ACH", "CHECK", "WIRE", "CAD_EFT", "TRIUMPH_PAY", "COMCHECK", "EFS", "ECHECK"

  - `status` (string,null)
    Payment method status
    Example: "ACTIVE"

  - `isPreferred` (boolean,null)
    Whether this is the preferred payment method for the carrier
    Example: true

  - `email` (string,null)
    Email address for payment notifications
    Example: "payments@carrier.com"

  - `phone` (string,null)
    Phone number for payment contact
    Example: "+1-555-123-4567"

  - `companyName` (string,null)
    Company name for this payment method (may differ from carrier name)
    Example: "Carrier Payments LLC"

  - `username` (string,null)
    Username for payment platforms (e.g., Zelle, Venmo)
    Example: "carrier_payments"

  - `bankName` (string,null)
    Bank name
    Example: "Chase Bank"

  - `bankAddress` (string,null)
    Bank address
    Example: "123 Bank Street, Dallas, TX 75201"

  - `accountName` (string,null)
    Bank account holder name
    Example: "Carrier Transport Inc"

  - `accountNumber` (string,null)
    Bank account number (masked in responses)
    Example: "****1234"

  - `abaAch` (string,null)
    ABA/ACH routing number for electronic transfers
    Example: "021000021"

  - `wire` (string,null)
    Wire transfer routing number
    Example: "026009593"

  - `swiftCode` (string,null)
    SWIFT/BIC code for international transfers
    Example: "CHASUS33"

  - `eftInstitution` (string,null)
    EFT institution number (Canadian banking)
    Example: "001"

  - `eftTransit` (string,null)
    EFT transit number (Canadian banking)
    Example: "00010"

  - `clabe` (string,null)
    CLABE number (Mexican banking identifier)
    Example: "012180001234567897"

  - `currency` (string,null)
    Preferred currency code (ISO 4217)
    Example: "USD"

  - `carrierFactor` (any)
    Factoring company reference (required when paymentRecipientType is FACTOR).

When paymentRecipientType is DIRECT, this must be null.

  - `paymentTerm` (any)
    Payment terms for this payment method

  - `createdAt` (string, required)
    When the payment method was created
    Example: "2025-01-15T10:00:00Z"

  - `updatedAt` (string, required)
    When the payment method was last updated
    Example: "2025-01-15T14:30:00Z"

  - `deletedAt` (string,null)
    When the payment method was soft deleted (null if active)

  - `deletedBy` (any)
    User who deleted this payment method

## Response 400 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 401 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 404 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 409 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 422 fields (application/json):

  - `error` (string, required)
    Error code
    Example: "validation_error"

  - `message` (string, required)
    Human-readable error message

  - `details` (array, required)
    Validation error details

  - `details.field` (string, required)
    Field name that failed validation

  - `details.message` (string, required)
    Validation error message

## Response 500 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message