{
  "opencollection": "1.0.0",
  "info": {
    "name": "MVMNT Bill Payments Carrier Payment Methods API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Carrier Payment Methods",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Filter carrier payment methods",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/carrier-payment-methods/filter",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query carrier payment methods using flexible filter criteria with AND/OR logic.\n\nBy default, only non-deleted payment methods are returned (deletedAt: { isNull: true }).\nOverride this by explicitly setting deletedAt filter criteria.\n\nCarrier payment methods define how and where payments are sent for a specific carrier.\n"
        },
        {
          "info": {
            "name": "Create carrier payment method",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/carrier-payment-methods",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new carrier payment method.\n\n**Payment Recipient Type Constraints:**\n- **DIRECT**: Payment goes to carrier directly. `carrierFactorId` must be null or omitted.\n- **FACTOR**: Payment goes to factoring company. `carrierFactorId` is required.\n\n**Important**: The `carrierId` cannot be changed after creation.\n"
        },
        {
          "info": {
            "name": "Get carrier payment method",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mvmnt.io/v1/carrier-payment-methods/:id",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              }
            ]
          },
          "docs": "Retrieve a single carrier payment method by its unique identifier.\n\nReturns full details including banking information and associated carrier/factor references.\n"
        },
        {
          "info": {
            "name": "Update carrier payment method",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.mvmnt.io/v1/carrier-payment-methods/:id",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Partially update a carrier payment method. Only provided fields will be updated.\n\n**IMPORTANT**: The `carrierId` field cannot be changed after creation.\n\n**Payment Recipient Type Constraints:**\n- When changing to **DIRECT**: `carrierFactorId` must be set to null\n- When changing to **FACTOR**: `carrierFactorId` is required\n\n- **Omitted fields**: Not modified (current value preserved)\n- **Provided fields**: Updated to the new value\n- **Null values**: Clear the field (set to null) where applicable\n"
        },
        {
          "info": {
            "name": "Delete carrier payment method",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mvmnt.io/v1/carrier-payment-methods/:id",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              }
            ]
          },
          "docs": "Soft delete a carrier payment method (sets deletedAt timestamp).\n\nThe payment method will no longer appear in default queries but can be retrieved\nby explicitly filtering for deleted records.\n"
        }
      ]
    }
  ],
  "bundled": true
}